View as Markdown
Metabase icon

Metabase ACTION

Get Database

Retrieve database information. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Metabase account once, then configure and run Get Database from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "metabase-get-database",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    metabase: { authProvisionId: "apn_xxxxxxx" },
    databaseId: 10,
    include: "Include",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Database inputs
Property Type Description
databaseId Database ID integer
The ID of the database
Required Dynamic
include Include string
What to include in the response
Optional
includeEditableDataModel Include Editable Data Model boolean
Whether to include editable data model information
Optional
excludeUneditableDetails Exclude Uneditable Details boolean
Whether to exclude uneditable details from the response
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
metabase-get-database
Version
0.0.4
App
Metabase
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes