Metabase

Learn how to use Metabase with Composio

Overview

SLUG: METABASE

Description

Metabase is an open-source business intelligence tool that lets you ask questions about your data and visualize answers as charts, graphs, and dashboards.

Authentication Details

full
stringRequired
generic_api_key
stringRequired

Connecting to Metabase

Create an auth config

Use the dashboard to create an auth config for the Metabase toolkit. This allows you to connect multiple Metabase accounts to Composio for agents to use.

1

Select App

Navigate to Metabase.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Metabase Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4metabase_auth_config_id = "ac_YOUR_METABASE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Metabase for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, metabase_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Metabase toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Create Bookmark

Description

Tool to create a new bookmark for a Metabase item (card, dashboard, collection, or dataset). Use when the user wants to bookmark a specific item for quick access.

Action Parameters

id
integerRequired
model
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Bookmark

Description

Tool to create a new bookmark for a Metabase item (card, dashboard, collection, or dataset). Use when you need to bookmark a specific item for the authenticated user.

Action Parameters

id
integerRequired
model
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Run Card Pivot Query

Description

Tool to run a pivot table query on a Metabase card (question). Use when you need to execute the query associated with a specific card and get results formatted for pivot table visualization. The response includes data rows, column metadata, query status, and execution timing.

Action Parameters

card_id
integerRequired
collection_preview
ignore_cache
parameters

Action Response

context
data
objectRequired
database_id
error
json_query
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Run Card Query

Description

Tool to run the query associated with a Card and return its results. Use when you need to execute a card's query with optional parameters and cache control.

Action Parameters

card_id
integerRequired
ignore_cache
parameters

Action Response

context
data
objectRequired
database_id
error
json_query
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Copy Dashboard

Description

Tool to create a copy of an existing Metabase dashboard. Use when you need to duplicate a dashboard with optional customization of name, description, and collection placement. Supports both shallow copy (references same cards) and deep copy (duplicates all cards).

Action Parameters

collection_id
collection_position
description
from_dashboard_id
integerRequired
is_deep_copy
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Run Dashboard Pivot DashCard Query

Description

Tool to run a pivot table query for a specific DashCard. Use when you need to execute a pivot table query on a dashboard card with optional parameter filters.

Action Parameters

card_id
integerRequired
dashboard_id
integerRequired
dashcard_id
integerRequired
parameters

Action Response

average_execution_time
cached
context
data
database_id
error
json_query
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Save Dashboard to Collection

Description

Tool to save a denormalized dashboard description into a collection. Use when you need to create a new dashboard directly in a specific collection with full configuration including cards, tabs, and parameters.

Action Parameters

archived
auto_apply_filters
Defaults to True
cache_ttl
caveats
collection_position
creator_id
integerRequired
dashcards
array
description
embedding_params
enable_embedding
name
stringRequired
parameters
array
parent_collection_id
integerRequired
show_in_getting_started
tabs
array
width
Defaults to fixed

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discard Database Field Values

Description

Tool to discard all saved field values for a specific database. Use when you need to clear cached field value data for all fields in a database. Requires superuser privileges.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Dismiss Database Sync Spinner

Description

Tool to manually set the initial sync status of a Database and corresponding tables to complete. Use when you need to dismiss the synchronization spinner for a database after initial setup.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Trigger Database Field Values Rescan

Description

Tool to trigger a manual scan of field values for a Database. Use when you need to refresh field values for filter dropdowns after data changes. Requires superuser permissions.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Trigger Database Schema Sync

Description

Tool to trigger a manual update of the schema metadata for a Database. Use when you need to refresh the database schema metadata in Metabase after structural changes.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Field Dimension

Description

Tool to set the dimension for a field at the specified ID in Metabase. Use when you need to configure field remapping or display values for better data presentation.

Action Parameters

human_readable_field_id
integerRequired
id
integerRequired
name
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discard Field Values

Description

Tool to discard the FieldValues belonging to a Metabase field. Use when you need to clear cached field values. Only applies to fields that have FieldValues. If the Field's Database is set up to automatically sync FieldValues, they will be recreated during the next sync.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Field Values

Description

Tool to update field values and human-readable values for a Field whose semantic type is category/city/state/country or whose base type is type/Boolean. Use when you need to set or update the distinct values for a field along with optional human-readable remappings.

Action Parameters

id
integerRequired
values
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Unpersist Card

Description

Tool to unpersist a Metabase card/model. Deletes the persisted table backing the model and all queries after this will use the card's query rather than the saved version. Use when you need to remove persistence from a model.

Action Parameters

card_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Disable Database Model Persistence

Description

Tool to disable model persistence for a Metabase database. Use when you need to turn off caching of model results. Returns success whether persistence was already disabled or not (idempotent operation).

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discard Table Field Values

Description

Tool to discard the FieldValues belonging to the Fields in a Metabase Table. Use when you need to clear cached field values for all fields in a table. Only applies to fields that have FieldValues. If this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next sync.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Rescan Table Field Values

Description

Tool to manually trigger an update for FieldValues for Fields belonging to a specific Table. Use when you need to refresh field value caches after table data changes. Only applies to Fields that are eligible for FieldValues.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Sync Table Schema

Description

Tool to trigger a manual update of the schema metadata for a specific Table. Use when you need to refresh table schema information after database changes. This synchronizes columns, data types, and other metadata from the underlying database.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Action

Description

Tool to delete an Action from Metabase. Use when you need to permanently remove an action. This operation cannot be undone.

Action Parameters

action_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Action

Description

Tool to delete a Metabase action by its ID. Use when you need to permanently remove an action from the system.

Action Parameters

action_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Bookmark

Description

Tool to delete a bookmark from a Metabase item (card, dashboard, or collection). Use when you need to remove a bookmark from a specific item.

Action Parameters

id
integerRequired
model
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete API Cache

Description

Tool to delete/clear cached data in Metabase for specific entities. Use when you need to invalidate cache for a database, dashboard, question, or clear all cache (root).

Action Parameters

model
stringRequired
model_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Card

Description

Tool to delete a Metabase card (question) by its ID. Use when you need to permanently remove a card. Note: This endpoint is deprecated - consider archiving cards instead.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Dashboard

Description

Tool to delete a Metabase dashboard by its ID. Use when you need to permanently remove a dashboard.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Model Index

Description

Tool to delete a Metabase model index by its ID. Use when you need to permanently remove a model index entry.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Timeline Event

Description

Tool to delete a timeline event by ID. Use when you need to permanently remove a specific timeline event from Metabase.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Timeline

Description

Tool to delete a timeline by ID. Use when you need to permanently remove a timeline. Returns success status on completion.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete User Key-Value

Description

Tool to delete a user key-value pair from Metabase. Use when you need to remove a stored key-value entry within a specific namespace.

Action Parameters

key
stringRequired
namespace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Bookmark

Description

Tool to delete a bookmark by model and ID. Use when you need to remove a bookmark assigned to the user making the request. The operation returns HTTP 204 No Content on successful deletion.

Action Parameters

id
integerRequired
model
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Card

Description

Tool to hard delete a Metabase card. Use when you need to permanently remove a card from the system. For soft deletion, use PUT /api/card/:id instead.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Dashboard

Description

Tool to hard delete a Metabase dashboard by its ID. Use when you need to permanently remove a dashboard. This will also remove any questions/models/segments/metrics that use this database. For soft delete, use the update dashboard action instead.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete User Subscriptions

Description

Tool to delete all Alert and DashboardSubscription subscriptions for a User. Use when you need to remove all subscriptions for a specific user and archive alerts/dashboards they created. This is an enterprise feature requiring admin privileges or current user access.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Field Dimension

Description

Tool to remove the dimension associated with a field at the specified ID. Use when you need to disassociate a dimension from a field in Metabase.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Glossary Entry

Description

Tool to delete a glossary entry from Metabase. Use when you need to permanently remove a glossary entry by its ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Glossary Item

Description

Tool to delete a glossary item by ID. Use when you need to remove a glossary term from Metabase. The operation returns HTTP 204 No Content on successful deletion.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Model Index

Description

Tool to delete a ModelIndex by ID from Metabase. Use when you need to remove a model index from the system.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Timeline

Description

Tool to delete a Metabase timeline and cascade delete all its associated events. Use when you need to permanently remove a timeline. Deletion is permanent and cannot be undone.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Timeline Event

Description

Tool to delete a Metabase timeline event. Use when you need to permanently remove a timeline event from the system.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete User Key-Value Pair

Description

Tool to delete a user key-value pair by namespace and key. Use when you need to remove a specific key-value entry from a user's namespace.

Action Parameters

key
stringRequired
namespace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete User Subscriptions

Description

Tool to delete all Alert and DashboardSubscription subscriptions for a User. Also archives all Alerts and DashboardSubscriptions created by the User. Requires premium token with :audit-app feature. Only allowed for admins or current user.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Action

Description

Tool to retrieve a Metabase action by ID. Use when you need to fetch details about a specific action including its configuration, parameters, and metadata.

Action Parameters

action_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Action Execute Parameters

Description

Tool to fetch values for filling in action execution parameters. Use when you need to get parameter values for executing an action by providing PK parameters and values to select.

Action Parameters

action_id
integerRequired
parameters
stringDefaults to {}

Action Response

data
object
error
successful
booleanRequired

Tool Name: Get all Metabase actions

Description

Tool to retrieve all actions available in the Metabase instance. Actions are entities that let you build custom forms and business logic with parameterized SQL that writes back to your database. Returns an array of action objects including query, http, and implicit action types.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Recent Activity Views

Description

Tool to retrieve recently viewed items in Metabase. Use when you need to get a list of cards, dashboards, collections, tables, or documents that the authenticated user has recently accessed. Returns metadata including timestamps and permissions for each viewed item.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Alerts

Description

Tool to retrieve all alerts in Metabase. Use when you need to get a list of all configured alerts with their settings and notification channels.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Candidates

Description

Tool to retrieve automagic dashboard candidates for a specific database. Use when you need to discover interesting tables and schemas for automatic dashboard generation. Returns an array of schema candidates with their tables, ordered by interestingness score.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Cell Analysis

Description

Tool to return an automagic dashboard analyzing a specific cell in an entity's data. Use when you need to generate automated insights and visualizations for a cell query within a table, database, or other Metabase entity. The cell-query must be a base64-encoded JSON object in MBQL format that defines which cell to analyze.

Action Parameters

cell_query
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired
show

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Cell Rule Analysis

Description

Tool to fetch an automagic dashboard analyzing a specific cell using a template rule. Use when you need to generate automated insights and visualizations for a cell query with a specific dashboard template (e.g., correlations analysis, overview). Returns a dashboard with cards analyzing the specified cell using the given template from the prefix directory.

Action Parameters

cell_query
stringRequired
dashboard_template
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired
prefix
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Query Metadata

Description

Tool to retrieve all metadata for an automagic dashboard for the specified entity type and ID. Use when you need databases, tables, fields, segments, metrics, cards, dashboards, or snippets metadata. Returns comprehensive metadata used to build automagic dashboards that automatically analyze data patterns.

Action Parameters

entity
stringRequired
entity_id_or_query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard with Rule and Template

Description

Tool to retrieve an automagic dashboard for a specified entity using a specific rule prefix and dashboard template. Use when you need to get auto-generated analytics with a particular template configuration.

Action Parameters

dashboard_template
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired
prefix
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User Bookmarks

Description

Tool to retrieve all bookmarks for the authenticated user. Use when you need to fetch bookmarked cards, dashboards, or collections.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get API Card

Description

Tool to list all cards (questions) available to the authenticated user in Metabase. Use when you need to retrieve all saved questions, queries, or visualizations.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Card Parameter Values

Description

Tool to search for values of a specific parameter in a Metabase card. Use when you need to provide autocomplete/search functionality for card parameters (template tags). The card must have parameters defined with dimension/field filter type.

Action Parameters

card_id
integerRequired
param_key
stringRequired
query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card by ID

Description

Tool to retrieve a specific card (question) by its ID. Use when you need to get detailed information about a card including its query, visualization settings, and metadata.

Action Parameters

id
integerRequired
legacy_mbql

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Dashboards

Description

Tool to get a list of dashboards containing a specific card. Use when you need to find which dashboards include a particular card/question.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Series

Description

Tool to retrieve series data for a specific card. Use when you need to get information about multiple series associated with a card. The card must have a display type of bar, scalar, line, or area to support series.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all collections

Description

Tool to retrieve all collections that the current user has read permissions for. Returns collections with can_write property indicating write permissions. Use when you need to list available collections or check collection permissions.

Action Parameters

archived

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection by ID

Description

Tool to retrieve detailed information about a Metabase collection by its ID. Use when you need to get collection metadata, permissions, and hierarchy information. Accepts either a numeric collection ID or the string 'root' for the root collection.

Action Parameters

id
Required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection Items

Description

Tool to retrieve items from a specific Metabase collection. Use when you need to list cards (questions), dashboards, nested collections, or pulses within a collection. Supports filtering by item type and archived status.

Action Parameters

archived
id
stringRequired
model

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Root Collection

Description

Tool to fetch the Root Collection and its top-level objects. Use when you need to list items at the root level that the current user can access. Shows objects with no collection_id for users with Root Collection permissions, or objects with effective location of / for others.

Action Parameters

archived
model

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection Tree

Description

Tool to retrieve the collection tree structure from Metabase. Use when you need to view the hierarchical organization of collections. Official collections are returned first in the response. Supports filtering by archived status, user ownership, depth, and specific collection ID.

Action Parameters

collection_id
exclude_archived
exclude_other_user_collections
shallow

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard Parameter Remapping

Description

Tool to get parameter remapping for a dashboard parameter value. Use when you need to retrieve remapped values or human-readable representations for a specific parameter value in a Metabase dashboard.

Action Parameters

id
integerRequired
param_key
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard Parameter Values

Description

Tool to fetch available values for a specific dashboard parameter. Use when you need to get the list of possible values that can be used to filter a dashboard parameter.

Action Parameters

id
integerRequired
param_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Databases

Description

Tool to retrieve a list of all Database instances configured in Metabase. Use when you need to get information about available databases.

Action Parameters

Action Response

data
arrayRequired
error
successful
booleanRequired
total
integerRequired

Tool Name: Get Database Details

Description

Tool to retrieve complete details for a specific database in Metabase. Use when you need to get database information including name, engine, features, schedules, and configuration settings.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Autocomplete Suggestions

Description

Tool to retrieve autocomplete suggestions for table and field names in a database. Use when you need to find tables or columns that match a specific prefix for query building in the SQL editor.

Action Parameters

id
integerRequired
prefix
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Card Autocomplete Suggestions

Description

Tool to get card autocomplete suggestions for a specific database in Metabase. Use when you need to search for cards (questions, models, or metrics) by name within a database.

Action Parameters

id
integerRequired
query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Fields

Description

Tool to retrieve all fields from a specific database in Metabase. Use when you need to get field metadata including names, types, and table associations for a given database ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Database Health

Description

Tool to check the health status of a specific database connection in Metabase. Use when you need to verify if a database connection is working properly. Returns a status indicating whether the connection is healthy.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Metadata

Description

Tool to retrieve complete metadata for a specific database including all tables and fields. Use when you need detailed information about database structure, table schemas, and field properties.

Action Parameters

id
integerRequired
include_editable_data_model
include_hidden

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Virtual Database Datasets

Description

Tool to retrieve all datasets from a Metabase virtual database. Use when you need to list available dataset collections for a virtual database (commonly the Saved Questions virtual database with ID -1337).

Action Parameters

virtual_db
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User Audit Info

Description

Tool to get audit info for the current authenticated user. Returns audit collection info if the user has permissions to access the audit collection, otherwise returns empty map. Requires enterprise audit-app feature.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Billing API Version

Description

Tool to retrieve the billing API version information for the Metabase Enterprise Edition instance. Use when you need to check the billing API version.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Resource Dependents

Description

Tool to get dependents of a resource in Metabase's dependency graph. Use when you need to find which resources depend on a specific resource (e.g., which dashboards use a particular card). This is an Enterprise Edition feature that helps track dependencies between different Metabase objects.

Action Parameters

dependent_type
stringRequired
id
integerRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Embedding Hub Checklist

Description

Tool to retrieve the embedding hub checklist status for Metabase Enterprise Edition. Use when you need to check the progress of embedding setup steps.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Current Remote Sync Task

Description

Tool to retrieve the current remote sync task status in Metabase. Use when you need to check if a remote sync operation is currently running. Returns HTTP 204 when no task is active, or task details when a sync is in progress.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Stale Data By ID

Description

Tool to retrieve stale data information by ID from Metabase Enterprise Edition. Use when you need to fetch details about stale resources.

Action Parameters

id
integerRequired

Action Response

data
error
limit
offset
successful
booleanRequired
total

Tool Name: Get Uploaded Tables

Description

Tool to retrieve all uploaded tables in Metabase Enterprise Edition. Use when you need to list all tables that were created from CSV or file uploads.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Field Values

Description

Tool to search for field values in Metabase that start with a given string. Use when you need autocomplete or type-ahead functionality for field values. Returns paired values from both the primary field and search field where the search field value starts with the provided string.

Action Parameters

id
integerRequired
limit
search_id
integerRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Field Values

Description

Tool to retrieve distinct values for a Metabase field. Use when you need to get all distinct values of a field that has has_field_values set to 'list', including any human-readable remapped values. Returns empty response for Saved Questions virtual database fields.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get API Glossary

Description

Tool to retrieve all glossary items from Metabase. Use when you need to list all glossary terms and their definitions available in the Metabase instance.

Action Parameters

Action Response

data
arrayRequired
error
successful
booleanRequired

Tool Name: Get Current User Login History

Description

Tool to retrieve login history for the currently authenticated user. Use when you need to audit or review login activity.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Model Index Values

Description

Tool to retrieve indexed field values for a specific Metabase model. Use when you need to get searchable text values that have been indexed for a model. Metabase indexes text/string fields from models to make them searchable.

Action Parameters

model_id
integerRequired

Action Response

data
array
error
successful
booleanRequired

Tool Name: Get Model Index Details

Description

Tool to retrieve details of a specific model index by its ID. Use when you need to get information about model indexing status, schedule, or configuration.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all native query snippets

Description

Tool to retrieve all native query snippets available in the Metabase instance. Native query snippets are reusable SQL fragments that can be included in native queries. Returns an array of snippet objects with their content and metadata.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Native Query Snippet by ID

Description

Tool to retrieve a specific native query snippet by its ID. Use when you need to get details about a saved SQL snippet including its content, metadata, and template tags.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Notifications

Description

Tool to retrieve notifications from Metabase with optional filtering. Use when you need to list notifications by creator, card, recipient, or include inactive ones. Returns an array of notification objects with their payloads, handlers, and creator information.

Action Parameters

card_id
creator_id
include_inactive
recipient_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Public Card by UUID

Description

Tool to fetch a publicly-accessible card by its public UUID and return card information including query definition, visualization settings, and parameters. Use when you need to retrieve card details that have been shared publicly. Does not require authentication when accessing via public UUID.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Public oEmbed Metadata

Description

Tool to get oEmbed metadata for public Metabase resources. Use when you need to generate embeddable content for public dashboards or questions following the oEmbed protocol.

Action Parameters

format
maxheight
maxwidth
url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Public Pivot Card Query

Description

Tool to fetch a publicly-accessible pivot card and return query results including data rows, column metadata, and query status. Use when you need to retrieve pivot table data for cards that have been shared publicly via a public UUID. Does not require authentication when accessing via public UUID.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
json_query
status
successful
booleanRequired

Tool Name: Get All Pulses

Description

Tool to retrieve all pulses (scheduled reports/subscriptions) in Metabase. Use when you need to get a list of configured pulses with their settings and delivery channels.

Action Parameters

archived
dashboard_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse Form Input Configuration

Description

Tool to retrieve configuration information for creating or updating Pulses (scheduled email reports). Returns available notification channels and user choices. Use when setting up or modifying pulse subscriptions.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse by ID

Description

Tool to retrieve a specific pulse (subscription) by its ID. Use when you need to get detailed information about a pulse including its channels, cards, schedule, and recipients.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse Preview Card

Description

Tool to retrieve the HTML preview of a Metabase card formatted for pulse emails. Use when you need to get the rendered HTML representation of a card for email delivery.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse Preview Card Info

Description

Tool to retrieve preview information for a Metabase card formatted for pulse emails. Use when you need both the HTML rendering and metadata about a card for pulse delivery. Returns a JSON object with the card ID, type, and HTML content.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse Preview Dashboard

Description

Tool to retrieve the pulse preview for a specific dashboard by its ID. Use when you need to see how a dashboard will appear in pulse/email notifications, including backend artifacts preview with card details.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Revision by ID and Entity

Description

Tool to retrieve a specific revision by ID and entity type. Use when you need to get details about a particular revision of a Metabase entity (card, dashboard, document, or segment).

Action Parameters

entity
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Entity Revision History

Description

Tool to retrieve the revision history for a Metabase entity (dashboard, card, metric, or segment). Use when you need to see the complete change history, who made changes, and what was modified. Returns an array of revision objects ordered from most recent to oldest.

Action Parameters

entity
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Search Weights

Description

Tool to retrieve the current search weight configuration for the Metabase instance. Use when you need to understand how search results are ranked based on factors like recency, bookmarks, view count, and other scoring factors.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Segments

Description

Tool to retrieve all segments from Metabase. Use when you need to list all available segments or filter definitions for tables.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Validate Password Reset Token

Description

Tool to validate a password reset token in Metabase. Use when you need to check if a password reset token is still valid and can be used to reset a user's password.

Action Parameters

token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Session Properties

Description

Tool to retrieve all global session properties and their values that are public. Use when you need to access configuration settings visible to the current user.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Table Foreign Keys

Description

Tool to retrieve foreign key relationships for a card-based virtual table. Use when you need to get FK information for a saved question (card). Note that virtual tables typically return an empty array as they don't have traditional database foreign key relationships.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Virtual Table Query Metadata

Description

Tool to retrieve metadata for a virtual table created from a card (saved question). Use when you need comprehensive information about a card's virtual table including database details, fields with their types and properties, field foreign keys, segments, and metrics.

Action Parameters

id
integerRequired
include_sensitive_fields

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table Foreign Keys

Description

Tool to retrieve foreign key relationships for a Metabase table. Use when you need to understand how a table relates to other tables through foreign keys.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table Query Metadata

Description

Tool to retrieve metadata about a table useful for running queries. Use when you need comprehensive table information including database details, fields with their types and properties, field foreign keys, field values, segments, and metrics.

Action Parameters

id
integerRequired
include_sensitive_fields

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table Data by ID

Description

Tool to retrieve data from a specific Metabase table by ID. Use when you need to fetch actual data rows and column metadata for a table. Returns table data including rows, column definitions, and query execution statistics.

Action Parameters

table_id
integerRequired

Action Response

context
data
objectRequired
database_id
error
row_count
running_time
status
successful
booleanRequired

Tool Name: Get All Timelines

Description

Tool to retrieve all timelines in Metabase. Use when you need to get a list of all timelines with their settings, events, and associated metadata.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection Timelines

Description

Tool to retrieve timelines associated with a specific Metabase collection. Use when you need to get all timelines and their events for a collection. Returns an empty array if the collection has no timelines.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Root Collection Timelines

Description

Tool to retrieve all timelines associated with the root collection. Use when you need to get timelines where items have no collection_id. The root collection is a virtual collection for items without a specific collection assignment.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Timeline Event

Description

Tool to retrieve a timeline event by ID. Use when you need to fetch details about a specific timeline event including its name, description, timestamp, and metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Timeline by ID

Description

Tool to fetch a timeline by its ID from Metabase. Use when you need to retrieve timeline details including optional events. Add include='events' to get unarchived events, and archived=true to return all events.

Action Parameters

archived
id
integerRequired
include

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Current User

Description

Tool to retrieve information about the currently authenticated user. Use when you need to get the current user's profile, permissions, and account details.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User by ID

Description

Tool to retrieve a specific user by their ID. Use when you need to get detailed information about a user including their profile, permissions, and status.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User Key-Value by Namespace

Description

Tool to retrieve all user key-value pairs for a specified namespace. Use when you need to fetch user-specific settings or preferences stored within a namespace. Returns HTTP 204 (No Content) when the namespace exists but contains no data.

Action Parameters

namespace
stringRequired

Action Response

data
error
namespace
successful
booleanRequired

Tool Name: Get User Recipients

Description

Tool to retrieve users for recipient selection. Returns only active users with permissions-based filtering applied. Use when you need to get a list of users that can be selected as recipients for notifications, alerts, or subscriptions.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Generate Random Security Token

Description

Tool to generate a cryptographically secure random token for Metabase. Use when you need to generate a secure token for embedding-secret-key or other security purposes.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard

Description

Tool to generate an automagic dashboard for a given entity. Use when you need to create a dashboard with automatically generated insights and visualizations based on the entity type and ID. Automagic dashboards provide instant analytics without manual configuration.

Action Parameters

entity
stringRequired
entity_id_or_query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard

Description

Tool to retrieve an automagic dashboard for a specified entity with its ID. Use when you need to get auto-generated analytics and visualizations for tables, databases, cards, segments, or adhoc queries.

Action Parameters

entity
stringRequired
entity_id_or_query
stringRequired
show

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Cell Analysis

Description

Tool to return an automagic dashboard analyzing a specific cell in an entity's data. Use when you need to generate automated insights and visualizations for a cell query within a table, database, or other Metabase entity. The cell-query must be a base64-encoded JSON object in MBQL format.

Action Parameters

cell_query
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired
show

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Cell Rule

Description

Tool to fetch an automagic dashboard analyzing a specific cell in a table or query. Use when you need to explore correlations or patterns for a specific column/cell. Returns a dashboard with visualizations analyzing the specified cell using the given template.

Action Parameters

cell_query
stringRequired
dashboard_template
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired
prefix
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboards Compare

Description

Tool to return an automagic comparison dashboard for entity with id compared with comparison-entity with comparison-entity-id-or-query. Use when you need to generate a visual comparison dashboard between two entities (tables, segments, or adhoc queries).

Action Parameters

comparison_entity
stringRequired
comparison_entity_id_or_query
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Automagic Dashboard Query Metadata

Description

Tool to retrieve all metadata for an automagic dashboard for a specific entity and ID. Use when you need to get complete metadata including databases, tables, fields, segments, metrics, and other related objects for generating automagic dashboards.

Action Parameters

entity
stringRequired
entity_id_or_query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get automagic dashboard by rule

Description

Tool to return an automagic dashboard for a specific entity using a dashboard template with rule prefix. Use when you need to generate an auto-generated analytical dashboard for a table, segment, or adhoc query with specific visualization patterns.

Action Parameters

dashboard_template
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired
prefix
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Dashboards

Description

Tool to get a list of dashboards that a specific card appears in. Use when you need to find which dashboards contain a particular card. Returns an array of dashboard objects with id and name for each dashboard.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Query Metadata

Description

Tool to get comprehensive query metadata for a Metabase card (saved question). Use when you need detailed information about the database structure, tables, fields, segments, and metrics associated with a card. This endpoint consolidates metadata that would otherwise require multiple API calls to /api/field/:id, /api/database/:id, and /api/table/:id/query_metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Card Series

Description

Tool to fetch a list of cards compatible as series with a specified card. Only cards with display types 'bar', 'scalar', 'line', or 'area' are compatible with series functionality. Use when you need to find cards that can be combined into multi-series visualizations. Returns 400 error for incompatible card types like 'smartscalar'.

Action Parameters

id
integerRequired
last_cursor
query

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection by ID

Description

Tool to fetch a specific Metabase collection with standard details added. Use when you need to retrieve detailed information about a collection including its name, description, permissions, hierarchy, and metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection Items

Description

Tool to fetch items from a specific Metabase collection. Use when you need to list cards, dashboards, nested collections, pulses, or snippets within a collection. Supports filtering by model type and archived status.

Action Parameters

archived
id
integerRequired
models

Action Response

data
arrayRequired
error
limit
models
offset
successful
booleanRequired
total

Tool Name: Get Automagic Comparison Dashboard

Description

Tool to retrieve an automagic comparison dashboard comparing a cell in one entity with another entity. Use when you need to generate comparative analytics and visualizations between two tables, segments, or adhoc queries based on a specific cell query.

Action Parameters

cell_query
stringRequired
comparison_entity
stringRequired
comparison_entity_id_or_query
stringRequired
entity
stringRequired
entity_id_or_query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard by ID

Description

Tool to retrieve details of a specific Metabase dashboard by ID. Use when you need to get dashboard information including name, description, cards, tabs, and parameters. Returns complete dashboard configuration and metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard by ID

Description

Tool to retrieve a dashboard by its ID from Metabase. Use when you need to fetch dashboard details including name, description, cards, parameters, and metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard Params Remapping

Description

Tool to fetch the remapped value for a given dashboard parameter in Metabase. Use when you need to get the remapped representation of a parameter value.

Action Parameters

id
integerRequired
param_key
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard Query Metadata

Description

Tool to get all of the required query metadata for the cards on a dashboard. Use when you need to understand what databases, tables, fields, snippets, and cards are used by a specific dashboard.

Action Parameters

dashboard_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Autocomplete Suggestions

Description

Tool to get autocomplete suggestions for table and field names in a Metabase database. Use when you need to search for database objects by prefix or substring in the SQL editor.

Action Parameters

id
integerRequired
prefix
substring

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database By ID

Description

Tool to retrieve a single database by ID from Metabase. Use when you need to get detailed information about a specific database, optionally including its tables and fields.

Action Parameters

id
integerRequired
include

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Card Autocomplete Suggestions

Description

Tool to return a list of Card autocomplete suggestions for a given query in a given Database. Use when the user needs to search for cards (questions or models) in a specific database, typically for autocomplete functionality.

Action Parameters

id
integerRequired
query
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Datasets

Description

Tool to retrieve tables (models and metrics) from a virtual database schema in Metabase. Use when you need to discover available datasets in the Saved Questions virtual database. The virtual database ID -1337 represents the Saved Questions database where models and metrics are stored.

Action Parameters

schema_name
stringRequired
virtual_db
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Fields

Description

Tool to retrieve all field metadata from a Metabase database. Use when you need to explore available fields across all tables in a database. Returns field names, types, display names, and table associations for building queries or understanding database structure.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Healthcheck

Description

Tool to check if a Metabase database can currently connect. Use when you need to verify database connectivity status. Returns the connection health status for the specified database ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Metadata

Description

Tool to retrieve complete metadata for a specific database including all tables and fields. Use when you need detailed information about database structure, table schemas, field properties, and field values.

Action Parameters

id
integerRequired
include_editable_data_model
include_hidden

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Schemas

Description

Tool to retrieve all schemas with tables for a specific database in Metabase. Use when you need to discover available database schemas. Returns only schemas that contain tables, excluding empty schemas.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Settings Available

Description

Tool to get all database-local settings and their availability for a given database. Use when you need to check which settings are available or enabled for a specific database. Returns a map of setting names to their availability status (enabled/disabled).

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Database Syncable Schemas

Description

Tool to retrieve all syncable schemas for a specific database in Metabase. Use when you need to discover schemas available for syncing or CSV uploads. Returns all schemas that can be synced, unlike the regular schemas endpoint which excludes empty schemas.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Stale Entities from Collection

Description

Tool to retrieve stale entities (cards and dashboards) from a Metabase collection that haven't been used recently. Use when you need to identify unused content for cleanup or archival purposes. Supports filtering by last edit date and pagination with limit/offset parameters.

Action Parameters

before_date
id
stringRequired
limit
offset

Action Response

data
arrayRequired
error
limit
offset
successful
booleanRequired
total
integerRequired

Tool Name: Get Field Remapping

Description

Tool to fetch remapped field values for a specific field in Metabase. Use when you need to retrieve human-readable display values that correspond to field values. Returns an array of value pairs where each pair contains the original field value and its remapped display text.

Action Parameters

id
integerRequired
limit
remapped_id
integerRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Field Summary

Description

Tool to get summary statistics for a Metabase field by its ID. Use when you need count and distinct count information for a specific field. Returns count (total values) and distincts (distinct unique values) for the specified field.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get ModelIndex by ID

Description

Tool to retrieve a ModelIndex by ID. Use when you need to get details about a specific model index including its state, references, and indexing information.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Most Recently Viewed Dashboard

Description

Tool to retrieve the most recently viewed dashboard for the authenticated user. Use when you need to check what dashboard the user last accessed.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Native Query Snippet by ID

Description

Tool to retrieve a specific native query snippet by its ID. Use when you need to fetch reusable SQL snippet details including content, creator, and metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse Preview Card

Description

Tool to get HTML rendering of a Metabase card by ID. Use when you need the rendered HTML representation of a card for pulse emails or preview purposes.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Pulse Preview Card Info

Description

Tool to get JSON object containing HTML rendering of a card and additional information. Use when you need to retrieve the rendered preview of a card for pulse/subscription display along with its metadata.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard HTML Preview

Description

Tool to retrieve an HTML preview rendering of a dashboard. Use when you need to get the HTML representation of a dashboard for rendering or pulse notifications.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Revision History by ID

Description

Tool to retrieve the complete revision history for a Metabase entity by its ID. Use when you need to see all changes made to a dashboard, card, metric, or segment, including who made them and when.

Action Parameters

entity
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table By ID

Description

Tool to retrieve basic table information by ID from Metabase. Use when you need table details including name, schema, entity type, and associated database information. For comprehensive table metadata with fields and query information, use the query_metadata endpoint instead.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table Data

Description

Tool to retrieve data from a specific table in Metabase. Use when you need to fetch the actual data rows and column metadata for a table. Returns table data including rows, column metadata, and optional statistics.

Action Parameters

table_id
integerRequired

Action Response

context
data
objectRequired
database_id
error
row_count
running_time
status
successful
booleanRequired

Tool Name: Get Table Foreign Keys

Description

Tool to get all foreign keys whose destination is a field that belongs to a specific table. Use when you need to retrieve foreign key relationships for a table.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table Query Metadata

Description

Tool to get metadata about a Table useful for running queries. Returns DB, fields, field FKs, and field values. Use when you need comprehensive table metadata for query construction or analysis.

Action Parameters

id
integerRequired
include_editable_data_model
include_hidden_fields
include_sensitive_fields

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Timeline by ID

Description

Tool to fetch a timeline by its ID. Use when you need to retrieve timeline details including events. Include include=events parameter to get unarchived events on the timeline, and add archived=true to return all events (both archived and unarchived).

Action Parameters

archived
id
integerRequired
include

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Collection Timelines

Description

Tool to fetch timelines associated with a specific Metabase collection. Use when you need to retrieve all timelines and their events for a given collection ID. Returns an empty array if the collection has no timelines.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Timeline Event

Description

Tool to fetch a timeline event by ID. Use when you need to retrieve details about a specific timeline event in Metabase.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User by ID

Description

Tool to fetch a Metabase user by their ID. Use when you need to retrieve user information including email, name, permissions, and authentication details. You must be fetching yourself or be a superuser or a Group Manager to access user information.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User Key-Value Setting

Description

Tool to retrieve a user-specific key-value pair from Metabase storage. Use when you need to fetch user preferences, settings, or stored values organized by namespace and key. Returns the stored value if it exists, or None for unset keys (HTTP 204 response).

Action Parameters

key
stringRequired
namespace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All User Key-Values in Namespace

Description

Tool to retrieve all key-value pairs in a given namespace for the current user. Use when you need to fetch all user preferences or settings within a specific namespace at once.

Action Parameters

namespace
stringRequired

Action Response

data
object
error
successful
booleanRequired

Tool Name: Get User Key-Value Setting

Description

Tool to retrieve a user-specific key-value pair from Metabase storage. Use when you need to fetch user preferences, settings, or stored values organized by namespace and key. Returns the stored value if it exists, or None for unset keys (HTTP 204 response).

Action Parameters

key
stringRequired
namespace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Record Recent Activity

Description

Tool to record recent activity for a Metabase item. Use when tracking user interactions with cards, dashboards, tables, or other Metabase objects. This helps maintain the user's recent activity history for quick access to frequently used items.

Action Parameters

context
stringRequired
model
stringRequired
model_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Bookmark

Description

Tool to create a bookmark for a Metabase item (card, dashboard, or collection). Use when you need to bookmark a specific item for quick access.

Action Parameters

id
integerRequired
model
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Card

Description

Tool to create a new Metabase card (question or model). Use when you need to create a new query, report, or visualization in Metabase.

Action Parameters

collection_id
collection_position
dataset_query
objectRequired
description
display
stringRequired
metadata_checksum
name
stringRequired
result_metadata
visualization_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Card Query

Description

Tool to execute a query for a saved Metabase card/question and retrieve results. Use when you need to run a saved question and get the data rows, columns, and metadata. Optionally accepts parameters for filtering results using template tag variables.

Action Parameters

card_id
integerRequired
parameters

Action Response

context
data
objectRequired
database_id
error
row_count
running_time
status
successful
booleanRequired

Tool Name: Bulk Move Cards to Collection

Description

Tool to bulk move multiple Metabase cards into a target collection or remove them from collections. Use when you need to organize multiple cards by moving them to a specific collection, or pass null as collection_id to remove cards from all collections.

Action Parameters

card_ids
arrayRequired
collection_id
Required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Copy Card

Description

Tool to create a copy of an existing Metabase card (question) by its ID. Use when you need to duplicate a card with all its query, visualization, and configuration settings.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Pivot Card Query

Description

Tool to execute a pivot query on a Metabase card and return the results. Use when you need to retrieve pivot table data for a specific card ID.

Action Parameters

card_id
integerRequired

Action Response

average_execution_time
cached
context
data
database_id
error
json_query
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Get Card Dashboard Associations

Description

Tool to retrieve dashboard associations for given card IDs. Returns an array with card_id and associated dashboards for each card. Use when you need to find which dashboards contain specific cards.

Action Parameters

card_ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bulk Move Cards

Description

Tool to bulk move cards to a collection or remove them from collections. Use when you need to organize multiple cards by moving them to a specific collection or removing them from all collections.

Action Parameters

card_ids
arrayRequired
collection_id
Required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Collection

Description

Tool to create a new Metabase collection for organizing content. Use when you need to create a collection with name and color. Collections are used to organize dashboards, questions, and models in Metabase.

Action Parameters

color
stringRequired
description
name
stringRequired
parent_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Dashboard

Description

Tool to create a new Metabase dashboard. Use when you need to create a new dashboard for organizing and displaying visualizations and reports.

Action Parameters

collection_id
collection_position
description
name
stringRequired
parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Copy Dashboard

Description

Tool to copy an existing Metabase dashboard. Use when you need to duplicate a dashboard with all its cards and configuration.

Action Parameters

collection_id
description
from_dashboard_id
integerRequired
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Dashboard Pivot Query

Description

Tool to execute a pivot table query for a specific card on a dashboard. Use when you need to transform regular query results into pivot table format with configurable rows, columns, and measures.

Action Parameters

card_id
integerRequired
dashboard_id
integerRequired
dashcard_id
integerRequired
parameters

Action Response

context
data
database_id
error
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Create Dashboard in Collection

Description

Tool to create a new dashboard in a specific Metabase collection. Use when you need to create a dashboard and save it to a particular collection.

Action Parameters

creator_id
integerRequired
description
name
stringRequired
parent_collection_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discard Database Field Values

Description

Tool to discard all saved field values for a specific database. Use when you need to clear cached field value data for all fields in a database. Requires superuser privileges.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Dismiss Database Spinner

Description

Tool to dismiss the spinner for a specific database. Use when you need to dismiss loading indicators for a database connection.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Rescan Database Field Values

Description

Tool to trigger a manual rescan of field values for a specific database. Use when you need to refresh field value caches after database schema changes. Requires superuser privileges.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Sync Database Schema

Description

Tool to trigger a schema synchronization for a specific database. Use when you need to refresh the database schema metadata in Metabase after structural changes.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Dataset Query

Description

Tool to execute a query against a Metabase database and retrieve results. Use when you need to run native SQL or MBQL queries. Supports both raw SQL queries (type='native') and structured MBQL queries (type='query').

Action Parameters

constraints
database
integerRequired
native
parameters
query
type
stringRequired

Action Response

average_execution_time
context
data
database_id
error
error_type
json_query
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Convert Query to Native SQL

Description

Tool to convert a Metabase query to native SQL format. Use when you need to get the formatted native SQL representation of a query.

Action Parameters

database
integerRequired
native
objectRequired
parameters
array
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remap Dataset Parameter Value

Description

Tool to remap dataset parameter values in Metabase. Use when you need to transform or map parameter values for dataset queries. Returns an array of remapped values based on the parameter configuration.

Action Parameters

parameter
objectRequired
value
Required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dataset Parameter Values

Description

Tool to fetch parameter values for dataset fields in Metabase. Use when you need to retrieve possible values for a parameter based on specific field IDs. Returns a list of value pairs and indicates if more values exist.

Action Parameters

field_ids
arrayRequired
parameter
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Pivot Table Query

Description

Tool to execute a pivot table query and retrieve results. Use when you need to run an MBQL query with aggregation and breakout fields to generate pivot table data.

Action Parameters

database
integerRequired
query
objectRequired
type
stringRequired

Action Response

data
objectRequired
database_id
error
json_query
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Get Dataset Query Metadata

Description

Tool to retrieve query metadata for a dataset query including databases, tables, fields, and snippets. Use when you need metadata about what's available for constructing or analyzing a query.

Action Parameters

database
integerRequired
query
objectRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Snippet Dependencies

Description

Tool to check dependencies for a native query snippet in Metabase Enterprise Edition. Use when you need to verify which cards or transforms depend on a specific snippet before modifying or deleting it.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Dashboard Subscription

Description

Tool to create a dashboard subscription using Metabot tools. Use when you need to set up automated delivery of a dashboard to an email address on a scheduled basis.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Filter Records

Description

Tool to filter records from a Metabase data source using metabot tools. Use when you need to apply filters to a table, query, or report to narrow down the data set. Returns an MBQL query object with the applied filters.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Generate Insights

Description

Tool to generate insights for a table using Metabot tools. Use when you need to automatically generate analytical insights or dashboard for a specific table.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Current User

Description

Tool to retrieve information about the current authenticated user in a Metabase metabot conversation. Use when you need to get details about the user making queries within a conversation context.

Action Parameters

conversation_id
stringRequired
profile_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Dashboard Details

Description

Tool to retrieve dashboard details for a Metabase metabot conversation. Use when you need to get information about a specific dashboard including its name, description, type, and verification status within a conversation context.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired
profile_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Document Details via Metabot

Description

Tool to retrieve document details using Metabase metabot tools. Use when you need to fetch specific document information by document ID within a conversation context.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Query Details

Description

Tool to get query details using Metabot tools API. Use when you need to retrieve detailed information about a query including its structure, ID, and result columns. Returns either structured output with query metadata or plain text output.

Action Parameters

conversation_id
stringRequired
profile_id
query
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Snippet Details

Description

Tool to retrieve SQL snippet details via Metabase metabot tools. Use when you need to get the full details of a specific snippet including its ID, name, content, and description within a metabot conversation context.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired
profile_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Metabot Snippets

Description

Tool to retrieve SQL snippets for a Metabase metabot conversation. Use when you need to get available snippets that can be used in SQL queries within a conversation context.

Action Parameters

conversation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Table Details

Description

Tool to retrieve comprehensive table details via Metabase metabot tools. Use when you need to get complete information about a specific table including its fields, metrics, and related tables within a metabot conversation context.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired
profile_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Query Datasource via Metabot

Description

Tool to query a Metabase datasource using Metabot tools. Use when you need to execute queries against tables or models within a conversation context. Requires either a table_id or model_id in the arguments.

Action Parameters

arguments
objectRequired
conversation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Metabot Search

Description

Tool to search Metabase entities using the metabot search API. Use when you need to search for tables, models, questions, dashboards, metrics, databases, or transforms within a metabot conversation context.

Action Parameters

conversation_id
stringRequired
created_at
database_id
entity_types
last_edited_at
limit
search_native_query
semantic_queries
term_queries
weights

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Metabase Items (Metabot V2)

Description

Tool to search Metabase items using the Metabot search v2 endpoint. Use when you need to find dashboards, questions, tables, models, metrics, or other Metabase entities using keyword or semantic search. Supports filtering by entity type, database, and dates.

Action Parameters

conversation_id
created_at
database_id
entity_types
last_edited_at
limit
Defaults to 50
search_native_query
semantic_queries
term_queries
weights

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Current Remote Sync Task

Description

Tool to cancel the current active Remote Sync task in Metabase Enterprise Edition. Use when you need to stop an ongoing remote sync operation. Returns 'No active task to cancel' when there is no active task running.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Translate Entity IDs

Description

Tool to translate Metabase entity IDs (21-character strings) to their numeric IDs. Use when you need to convert entity ID strings to numeric IDs for API operations.

Action Parameters

entity_ids
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discard Field Values

Description

Tool to discard cached FieldValues for a specific field. Use when you need to clear cached field values and force a refresh. Requires superuser privileges.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Rescan Field Values

Description

Tool to manually trigger an update for the FieldValues for a specific field. Use when you need to refresh the cached values for a field that is eligible for FieldValues. Only works with fields that have has_field_values set to 'list'.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Glossary Entry

Description

Tool to create a new glossary entry in Metabase. Use when you need to add a new term and its definition to the glossary.

Action Parameters

definition
stringRequired
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Model Index

Description

Tool to create a new model index in Metabase. Use when you need to enable search functionality on a model by indexing specific fields.

Action Parameters

model_id
integerRequired
pk_ref
arrayRequired
value_ref
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create native query snippet

Description

Tool to create a new native query snippet in Metabase. Native query snippets are reusable SQL fragments that can be included in native queries. Use when you need to create a new SQL snippet for reuse across multiple queries.

Action Parameters

content
stringRequired
description
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Notification

Description

Tool to create a new notification in Metabase. Use when you need to create notifications for cards or other resources.

Action Parameters

payload
objectRequired
payload_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Send Notification

Description

Tool to trigger sending an unsaved notification in Metabase. Use when you need to send a one-time notification for a card with custom handlers and templates. Returns success status when notification is sent (HTTP 204).

Action Parameters

handler_ids
handlers
arrayRequired
payload
objectRequired
payload_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Unpersist Card

Description

Tool to unpersist a Metabase card by its ID. Use when you need to remove persistence from a card's cached results.

Action Parameters

card_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Unpersist Database

Description

Tool to disable model persistence for a specific database. Use when you need to stop persisting model results for a database.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Product Feedback

Description

Tool to submit product feedback to Metabase. Use when you need to send feedback about the product from various sources.

Action Parameters

comments
source
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Pulse

Description

Tool to create a new pulse (scheduled report/subscription) in Metabase. Use when you need to set up automated delivery of card or dashboard results via email or Slack.

Action Parameters

cards
arrayRequired
channels
arrayRequired
collection_id
collection_position
creator_id
integerRequired
dashboard_id
name
stringRequired
parameters
skip_if_empty

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Revert Entity to Previous Revision

Description

Tool to revert a Metabase entity (card, dashboard, document, or segment) to a previous revision. Use when you need to undo changes and restore an entity to an earlier state.

Action Parameters

entity
stringRequired
id
integerRequired
revision_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Send Password Reset Email

Description

Tool to send a password reset email when user has forgotten their password. Use when you need to initiate a password reset for a user. Returns 204 status code on success regardless of whether the email exists (security measure).

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Password Complexity

Description

Tool to check if a password meets Metabase's configured password complexity rules. Use when you need to validate a password against current complexity requirements. The endpoint was previously at /api/util/password_check but was moved to /api/session/password-check.

Action Parameters

password
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Submit Bug Report to Slack

Description

Tool to submit a bug report to Slack via Metabase's bug reporting endpoint. Use when you need to send diagnostic information about a bug to the configured Slack channel. Requires Slack integration with 'metabase-bugs' channel to be properly configured.

Action Parameters

diagnosticInfo
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discard Table Field Values

Description

Tool to discard cached FieldValues for all Fields belonging to a specific Table. Use when you need to clear field value caches for a table. Requires superuser permissions.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Rescan Table Field Values

Description

Tool to trigger a manual rescan of field values for a specific table. Use when you need to refresh field value caches for all fields in a table after data changes.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Sync Table Schema

Description

Tool to trigger a manual update of the schema metadata for a specific Table. Use when you need to refresh table schema information after database changes.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Timeline

Description

Tool to create a new timeline in Metabase. Use when you need to create a timeline for organizing events.

Action Parameters

archived
collection_id
default
description
icon
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Dashboard Card Query

Description

Tool to execute a query for a specific card within a dashcard on a dashboard. Use when you need to retrieve query results for dashboard visualizations. Returns data rows, column metadata, and execution statistics.

Action Parameters

card_id
integerRequired
dashboard_id
integerRequired
dashcard_id
integerRequired
parameters

Action Response

context
data
database_id
error
row_count
running_time
started_at
status
successful
booleanRequired

Tool Name: Update Action by ID

Description

Tool to update an existing Metabase action by its ID. Use when you need to modify the name, description, query, or settings of an action. Returns the updated action object with the new updated_at timestamp.

Action Parameters

database_id
integerRequired
dataset_query
objectRequired
description
id
integerRequired
model_id
integerRequired
name
stringRequired
type
stringRequired
visualization_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Bookmark Ordering

Description

Tool to update the order of bookmarks for the authenticated user. Use when you need to reorder bookmarked cards, dashboards, or collections.

Action Parameters

orderings
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Card by ID

Description

Tool to update a specific card (question) by its ID. Use when you need to modify card properties like name, description, visualization settings, or query definition.

Action Parameters

archived
collection_id
collection_position
dataset_query
description
display
embedding_params
enable_embedding
id
integerRequired
metadata_checksum
name
result_metadata
visualization_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Collection by ID

Description

Tool to update an existing Metabase collection by its ID. Use when you need to modify collection properties like name, description, color, archive status, or move it to a different parent. All parameters except id are optional - only include the fields you want to update.

Action Parameters

archived
color
description
id
integerRequired
name
parent_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Dashboard

Description

Tool to update a Metabase dashboard by its ID. Use when you need to modify dashboard properties like name, description, parameters, collection placement, or archive status. Returns the updated dashboard object with all current settings and metadata.

Action Parameters

archived
collection_id
collection_position
description
enable_embedding
id
integerRequired
name
parameters
points_of_interest
show_in_getting_started

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Dashboard Cards

Description

Tool to update dashboard cards and tabs. DEPRECATED: This endpoint is marked for removal in v48 - use PUT /api/dashboard/:id instead to update dashcards along with other dashboard data. Use when you need to update card positions, sizes, or tab ordering on a dashboard.

Action Parameters

cards
id
integerRequired
ordered_tabs

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Database Configuration

Description

Tool to update a database configuration in Metabase. Use when you need to modify database settings such as name, description, connection details, or sync preferences. Requires superuser permissions.

Action Parameters

auto_run_queries
cache_ttl
description
details
objectRequired
engine
stringRequired
id
integerRequired
is_full_sync
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Field Metadata

Description

Tool to update a Metabase field by its ID. Use when you need to modify field metadata such as description, display_name, semantic_type, or visibility_type. Only fields included in the request will be updated; others remain unchanged.

Action Parameters

description
display_name
id
integerRequired
semantic_type
visibility_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Glossary Entry by ID

Description

Tool to update an existing glossary entry in Metabase by its ID. Use when you need to modify the term name or definition of an existing glossary entry.

Action Parameters

definition
stringRequired
id
integerRequired
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Native Query Snippet by ID

Description

Tool to update an existing native query snippet by its ID. Use when you need to modify the name, description, or SQL content of a saved snippet. At least one field (name, description, or content) should be provided to update.

Action Parameters

content
description
id
integerRequired
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Pulse by ID

Description

Tool to update an existing pulse (scheduled report/subscription) by ID. Use when you need to modify pulse settings like name, cards, channels, or skip_if_empty behavior.

Action Parameters

archived
cards
channels
collection_id
id
integerRequired
name
skip_if_empty

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Search Weights

Description

Tool to update search weights configuration in Metabase. Use when you need to customize how search results are ranked by adjusting scorer weights. Returns the current search weights configuration after update.

Action Parameters

bookmarked
dashboard
exact
mine
model
official-collection
pinned
prefix
recency
rrf
text
user-recency
verified
view-count

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Table Metadata

Description

Tool to update a Metabase table by its ID. Use when you need to modify table metadata such as display_name, description, visibility_type, caveats, or points_of_interest. Only fields included in the request will be updated; others remain unchanged.

Action Parameters

caveats
description
display_name
id
integerRequired
points_of_interest
visibility_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Table Metadata

Description

Tool to update a Metabase table metadata by its ID. Use when you need to modify table properties such as display_name, description, entity_type, visibility_type, caveats, or points_of_interest. Only fields included in the request will be updated; others remain unchanged.

Action Parameters

caveats
description
display_name
entity_type
id
integerRequired
points_of_interest
visibility_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Table Field Display Order

Description

Tool to update the display order of fields in a Metabase table. Use when you need to reorder how fields appear in a table's schema or query results.

Action Parameters

field_ids
arrayRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Timeline Event by ID

Description

Tool to update an existing timeline event by its ID. Use when you need to modify the name, description, timestamp, or other properties of a timeline event. Returns the updated event object.

Action Parameters

description
icon
id
integerRequired
name
time_matters
timestamp
timezone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Timeline by ID

Description

Tool to update an existing timeline by its ID. Use when you need to modify the name, description, icon, or other properties of a timeline. Returns the updated timeline object.

Action Parameters

archived
collection_id
default
description
icon
id
integerRequired
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update User by ID

Description

Tool to update an existing Metabase user by their ID. Use when you need to modify user information such as email, name, group memberships, or superuser status. All update fields are optional; only provided fields will be updated.

Action Parameters

email
first_name
group_ids
id
integerRequired
is_superuser
last_name
login_attributes

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Action

Description

Tool to update an existing Action in Metabase. Use when you need to modify action properties such as name, description, archived status, or configuration settings.

Action Parameters

archived
description
id
integerRequired
name
parameter_mappings
parameters
visualization_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Collection

Description

Tool to update an existing Metabase collection. Use when you need to modify collection properties such as name, description, color, archive/unarchive status, or move it to a different parent collection.

Action Parameters

archived
color
description
id
integerRequired
name
parent_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Dashboard

Description

Tool to update a Metabase dashboard by ID. Use when you need to modify dashboard properties like name, description, parameters, cards, or tabs. The request body accepts the same structure as the response from GET /api/dashboard/:id. When setting archived to true, the dashboard is moved to Trash; when false, you may provide a collection_id.

Action Parameters

archived
collection_id
dashcards
description
enable_embedding
id
integerRequired
name
parameters
tabs

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Dashboard Cards (Deprecated)

Description

Tool to bulk update dashboard cards and tabs. DEPRECATED - use PUT /api/dashboard/:id instead for new implementations. Use when you need to create, update, or delete multiple dashboard cards at once. Cards with negative IDs are created, existing IDs are updated, and omitted cards are deleted.

Action Parameters

cards
arrayRequired
id
integerRequired
ordered_tabs

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Database

Description

Tool to update a Database in Metabase. Use when you need to modify database properties like name, description, schedules, caveats, or points of interest. Supports partial updates - only provide fields you want to change. Requires superuser permissions.

Action Parameters

caveats
description
engine
id
integerRequired
name
points_of_interest
schedules

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Field Metadata

Description

Tool to update metadata for a Metabase field by its ID. Use when you need to modify field properties like description, display name, visibility, semantic type, or other metadata settings. Commonly used to improve data documentation and field configuration.

Action Parameters

caveats
description
display_name
fk_target_field_id
has_field_values
id
integerRequired
points_of_interest
semantic_type
settings
special_type
visibility_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Glossary Entry

Description

Tool to update an existing glossary entry in Metabase. Use when you need to modify the term name or definition of a glossary item. At least one of 'term' or 'definition' should be provided.

Action Parameters

definition
id
integerRequired
term

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Native Query Snippet

Description

Tool to update an existing native query snippet by ID. Use when you need to modify the name, content, or description of a saved SQL snippet.

Action Parameters

content
description
id
integerRequired
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Pulse

Description

Tool to update an existing pulse (scheduled report/subscription) by ID. Use when you need to modify pulse settings like name, cards, channels, or skip_if_empty behavior.

Action Parameters

archived
cards
channels
collection_id
collection_position
id
integerRequired
name
skip_if_empty

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Table by ID

Description

Tool to update a Table in Metabase by its ID. Use when you need to modify table metadata such as display name, description, visibility, or other table properties.

Action Parameters

caveats
description
display_name
entity_type
id
integerRequired
points_of_interest
show_in_getting_started
visibility_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Table Fields Order

Description

Tool to reorder fields in a Metabase table. Use when you need to change the display order of table fields. Provide an array of all active field IDs in the desired order.

Action Parameters

field_ids
arrayRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Timeline

Description

Tool to update a Metabase timeline by its ID. Use when you need to modify timeline properties like name, description, icon, or archive status. Returns the updated timeline object without events. Archiving a timeline will cascade archive all associated events.

Action Parameters

archived
collection_id
default
description
icon
id
integerRequired
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Timeline Event

Description

Tool to update an existing Metabase timeline event by its ID. Use when you need to modify the name, description, timestamp, icon, or other properties of a timeline event. Returns the updated event object with the new updated_at timestamp.

Action Parameters

archived
description
icon
id
integerRequired
name
time_matters
timeline_id
timestamp
timezone

Action Response

data
objectRequired
error
successful
booleanRequired