Metabase

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from METABASE_API_KEY is sent as the x-api-key header.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
METABASE_API_KEYYesMetabase API key (created in Admin settings > Authentication > API keys) Docs.
METABASE_HOSTYesMetabase hostname without scheme, e.g. acme.metabaseapp.com (Metabase Cloud) or your self-hosted domain.

Setup

  1. Locate your Metabase instance: Note your instance hostname, e.g. acme.metabaseapp.com (Metabase Cloud) or your self-hosted domain, and set it as METABASE_HOST in your .env. Veryfront connects with HTTPS. The default Docker container serves HTTP only, so put it behind an HTTPS reverse proxy or configure native HTTPS before using this connector.
  2. Create an API key: As an admin, go to Admin settings > Authentication > API keys, create a key, and assign it to a group whose permissions cover the databases and collections you need. Copy the key (shown once, prefixed mb_).
  3. Set the environment variable: Add the key to your .env as METABASE_API_KEY=mb_...
  4. Verify access: With METABASE_HOST configured, run List Databases.

Provider notes

  • Metabase authenticates with an 'x-api-key' header
  • Metabase is self-hosted or tenant-hosted, so every call goes to the METABASE_HOST environment variable (hostname only, HTTPS is assumed)
  • The API key inherits the permissions of the group it is assigned to

Provider API reference.

Tools

ToolAccessDescription
List Databases<br /><code className="reference-identifier">metabase__list_databases</code>ReadList databases
List Questions<br /><code className="reference-identifier">metabase__list_cards</code>ReadList questions
Run Question Query<br /><code className="reference-identifier">metabase__run_card_query</code>ReadRun question query
Search<br /><code className="reference-identifier">metabase__search</code>ReadSearch questions, dashboards, collections, and tables
Get Dashboard<br /><code className="reference-identifier">metabase__get_dashboard</code>ReadGet dashboard
List Collections<br /><code className="reference-identifier">metabase__list_collections</code>ReadList collections

Verify the connection

Call a read tool such as metabase__list_databases with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.