# Metabase Metabase is an open-source business intelligence tool that lets you ask questions about your data and visualize answers as charts, graphs, and dashboards. - **Category:** business intelligence - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 225 - **Triggers:** 0 - **Slug:** `METABASE` - **Version:** 20260312_00 ## Tools ### Create Bookmark **Slug:** `METABASE_CREATE_BOOKMARK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the specific item to bookmark | | `model` | string ("card" | "dashboard" | "collection" | "dataset") | Yes | The type of item to bookmark. Supported values: card (for questions/cards), dashboard, collection, or dataset | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run Card Pivot Query **Slug:** `METABASE_CREATE_CARD_PIVOT_QUERY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | Yes | The ID of the card (question) to run the pivot query on | | `parameters` | array | No | Optional query parameters for filtering. Format: [{"type":"category","value":"value","target":["variable",["template-tag","tag-name"]]}] | | `ignore_cache` | boolean | No | Optional parameter to ignore cached results and force a fresh query execution | | `collection_preview` | boolean | No | Optional parameter for collection preview mode | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run Card Query **Slug:** `METABASE_CREATE_CARD_QUERY1` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | Yes | ID of the card to query | | `parameters` | array | No | Query parameters to apply. Format: [{"type":"category","value":"value","target":["variable",["template-tag","tag-name"]]}] | | `ignore_cache` | boolean | No | Whether to bypass query cache and force fresh query execution | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Dashboard **Slug:** `METABASE_CREATE_DASHBOARD_COPY` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Optional name for the copied dashboard. Must be a non-blank string if provided | | `description` | string | No | Optional description for the copied dashboard | | `is_deep_copy` | boolean | No | Set to true to create a deep copy that duplicates all questions/cards in the dashboard. Required when the dashboard contains Dashboard Questions. Default is false (shallow copy) | | `collection_id` | integer | No | Optional collection ID where the copied dashboard should be placed. Must be greater than zero if provided | | `from_dashboard_id` | integer | Yes | The ID of the dashboard to copy | | `collection_position` | integer | No | Optional position within the collection. Must be greater than zero if provided | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run Dashboard Pivot DashCard Query **Slug:** `METABASE_CREATE_DASHBOARD_PIVOT_DASHCARD_CARD` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | Yes | The ID of the card (question) associated with the dashcard. This identifies the underlying query. | | `parameters` | array | No | Optional array of dashboard parameters to filter the query results. Each parameter can specify filtering criteria for the pivot table data. | | `dashcard_id` | integer | Yes | The ID of the dashcard within the dashboard. This is the specific card instance on the dashboard. | | `dashboard_id` | integer | Yes | The ID of the dashboard containing the pivot table card | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Save Dashboard to Collection **Slug:** `METABASE_CREATE_DASHBOARD_SAVE_COLLECTION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Dashboard name | | `tabs` | array | No | Array of dashboard tabs for organizing cards | | `width` | string | No | Dashboard width setting. Typically 'fixed' or 'full' | | `caveats` | string | No | Dashboard caveats or important notes | | `archived` | boolean | No | Whether the dashboard is archived | | `cache_ttl` | integer | No | Cache time-to-live in seconds | | `dashcards` | array | No | Array of dashboard cards. Each card represents a question/visualization on the dashboard | | `creator_id` | integer | Yes | ID of the user creating the dashboard. Use the ID from /api/user/current endpoint | | `parameters` | array | No | Array of dashboard parameters for filtering | | `description` | string | No | Dashboard description | | `embedding_params` | object | No | Parameters for embedding configuration | | `enable_embedding` | boolean | No | Whether embedding is enabled for this dashboard | | `auto_apply_filters` | boolean | No | Whether to automatically apply filters | | `collection_position` | integer | No | Position within the collection | | `parent_collection_id` | integer | Yes | The ID of the parent collection where the dashboard will be saved | | `show_in_getting_started` | boolean | No | Whether to show this dashboard in the getting started section | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Discard Database Field Values **Slug:** `METABASE_CREATE_DATABASE_DISCARD_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the database to discard field values for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Dismiss Database Sync Spinner **Slug:** `METABASE_CREATE_DATABASE_DISMISS_SPINNER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the database to dismiss the spinner for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Trigger Database Field Values Rescan **Slug:** `METABASE_CREATE_DATABASE_RESCAN_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID to rescan field values for. This is the unique identifier for the database in Metabase. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Trigger Database Schema Sync **Slug:** `METABASE_CREATE_DATABASE_SYNC_SCHEMA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID to sync schema for. This is the unique identifier for the database in Metabase. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Dataset Parameter Values **Slug:** `METABASE_CREATE_DATASET_PARAMETER_SEARCH` Tool to search for parameter values in datasets when editing cards or dashboards. Use when you need to provide autocomplete functionality for parameters. Expects a query string and returns matching values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The search query string to filter parameter values. Used for autocomplete functionality when editing cards or dashboards. | | `field_ids` | array | Yes | Array of field IDs to search parameter values from. These are database field IDs that the parameter is linked to. | | `parameter` | object | Yes | Parameter configuration object containing the parameter id and type | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Field Dimension **Slug:** `METABASE_CREATE_FIELD_DIMENSION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the field for which to set the dimension | | `name` | string | Yes | A display name for the dimension (must be a non-blank string) | | `type` | string | Yes | The type of dimension. Use 'external' for field remapping/display values (foreign key relationships) or 'internal' for internal dimension mappings | | `human_readable_field_id` | integer | Yes | The ID of the field that should be displayed instead of the original field value. This field provides human-readable values for the current field | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Discard Field Values **Slug:** `METABASE_CREATE_FIELD_DISCARD_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The field ID whose FieldValues should be discarded. Only applies to fields that have FieldValues configured. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Field Values **Slug:** `METABASE_CREATE_FIELD_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The field ID to update values for. Must be a field whose semantic type is category/city/state/country or whose base type is type/Boolean. | | `values` | array | Yes | Array of arrays containing value mappings. Each inner array represents a mapping between original value and optional human-readable replacement. Format: [["original1", "readable1"], ["original2", "readable2"]] or [["value1"], ["value2"]] for values without human-readable replacements. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unpersist Card **Slug:** `METABASE_CREATE_PERSIST_CARD_UNPERSIST` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | Yes | The ID of the card/model to unpersist. This deletes the persisted table backing the model. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disable Database Model Persistence **Slug:** `METABASE_CREATE_PERSIST_DATABASE_UNPERSIST` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The database ID to disable model persistence for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Discard Table Field Values **Slug:** `METABASE_CREATE_TABLE_DISCARD_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the table whose FieldValues should be discarded. 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rescan Table Field Values **Slug:** `METABASE_CREATE_TABLE_RESCAN_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Table ID to rescan field values for. This triggers an update for FieldValues for Fields belonging to this Table. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Sync Table Schema **Slug:** `METABASE_CREATE_TABLE_SYNC_SCHEMA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the table to sync schema for. This initiates a synchronization process that refreshes the table's schema information including columns, data types, and other metadata from the underlying database. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Action **Slug:** `METABASE_DELETE_API_ACTION_ACTION_ID` Tool to delete a Metabase action by its ID. Use when you need to permanently remove an action from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action_id` | integer | Yes | The ID of the action to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete API Cache **Slug:** `METABASE_DELETE_API_CACHE` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `model` | string ("root" | "database" | "dashboard" | "question") | Yes | Type of entity to clear cache for. Must be one of: root (clear all cache), database, dashboard, or question | | `model_id` | integer | Yes | ID of the specific entity to clear cache for. Must be an integer greater than or equal to zero. Use 0 for root model type to clear all cache | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Timeline **Slug:** `METABASE_DELETE_API_TIMELINE_ID` Tool to delete a timeline by ID. Use when you need to permanently remove a timeline. Returns success status on completion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the timeline to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Bookmark **Slug:** `METABASE_DELETE_BOOKMARK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the model item to unbookmark | | `model` | string ("card" | "dashboard" | "collection") | Yes | The model type - valid values are 'card' (for questions/cards), 'dashboard', or 'collection' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Card **Slug:** `METABASE_DELETE_CARD` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Dashboard **Slug:** `METABASE_DELETE_DASHBOARD` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the dashboard to delete. This will permanently remove the dashboard and any questions/models/segments/metrics that use this database | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete User Subscriptions **Slug:** `METABASE_DELETE_EE_AUDIT_APP_USER_SUBSCRIPTIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The user ID whose subscriptions will be deleted. This will delete all Alert and DashboardSubscription subscriptions for the user (so they will no longer receive them) and archive all Alerts and DashboardSubscriptions created by the user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Field Dimension **Slug:** `METABASE_DELETE_FIELD_DIMENSION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the field whose dimension association should be removed | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Glossary Entry **Slug:** `METABASE_DELETE_GLOSSARY` Tool to delete a glossary entry from Metabase. Use when you need to permanently remove a glossary entry by its ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the glossary entry to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Model Index **Slug:** `METABASE_DELETE_MODEL_INDEX` Tool to delete a ModelIndex by ID from Metabase. Use when you need to remove a model index from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ModelIndex ID to delete. Must be greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Timeline Event **Slug:** `METABASE_DELETE_TIMELINE_EVENT` Tool to delete a Metabase timeline event. Use when you need to permanently remove a timeline event from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the timeline event to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete User Key-Value Pair **Slug:** `METABASE_DELETE_USER_KEY_VALUE_NAMESPACE_KEY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | The key identifier to delete from the namespace | | `namespace` | string | Yes | The namespace identifier for the key-value pair | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Action **Slug:** `METABASE_GET_ACTION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action_id` | integer | Yes | The ID of the action to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Action Execute Parameters **Slug:** `METABASE_GET_ACTION_EXECUTE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action_id` | integer | Yes | The ID of the action to fetch execution parameters for | | `parameters` | string | No | JSON string containing execution parameters. Pass PK parameters and values to select. Can be an empty object {} if no parameters are needed | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get all Metabase actions **Slug:** `METABASE_GET_API_ACTION` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Popular Items **Slug:** `METABASE_GET_API_ACTIVITY_POPULAR_ITEMS` Tool to get the list of 5 popular items on the Metabase instance. Use when you need to discover frequently accessed dashboards or cards. Returns both dashboards and cards with their metadata including name, description, parent collection, and timestamps. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Recent Activity Views **Slug:** `METABASE_GET_API_ACTIVITY_RECENT_VIEWS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Alerts **Slug:** `METABASE_GET_API_ALERT` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Dashboard Candidates **Slug:** `METABASE_GET_API_AUTO_DASHBOARDS_DATABASE_ID_CANDIDATES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID to get automagic dashboard candidates for. This is the unique identifier of the database in Metabase. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Bookmarks **Slug:** `METABASE_GET_API_BOOKMARK` Tool to retrieve all bookmarks for the authenticated user. Use when you need to fetch bookmarked cards, dashboards, or collections. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Card **Slug:** `METABASE_GET_API_CARD` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Card Parameter Values **Slug:** `METABASE_GET_API_CARD_CARD_ID_PARAMS_PARAM_KEY_SEARCH_QUERY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The search query string to filter parameter values. Used for autocomplete/search functionality. | | `card_id` | integer | Yes | The ID of the card containing the parameter to search. Must be a valid card with defined parameters. | | `param_key` | string | Yes | The parameter key/name (template tag name) to search within. This must match a parameter defined in the card. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card by ID **Slug:** `METABASE_GET_API_CARD_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The Card identifier | | `legacy_mbql` | boolean | No | When set to true, returns the card dataset_query in MBQL 4 (legacy) format instead of MBQL 5 | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get all collections **Slug:** `METABASE_GET_API_COLLECTION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `archived` | boolean | No | If true, returns archived collections. If false or omitted, returns non-archived collections. Must be a valid boolean. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection by ID **Slug:** `METABASE_GET_API_COLLECTION_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the collection to retrieve. Can be a numeric ID (e.g., 1, 2) or the string 'root' for the root collection. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Items **Slug:** `METABASE_GET_API_COLLECTION_ID_ITEMS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Collection ID to retrieve items from. This is the unique identifier for the collection in Metabase. | | `model` | string ("card" | "collection" | "dashboard" | "pulse") | No | Filter results by object type. Use 'card' for questions, 'dashboard' for dashboards, 'collection' for nested collections, or 'pulse' for subscriptions/alerts. | | `archived` | string ("true" | "false") | No | Return archived items instead of unarchived ones. Use 'true' to get archived items or 'false' for active items. Defaults to false if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Root Collection **Slug:** `METABASE_GET_API_COLLECTION_ROOT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `model` | string ("card" | "collection" | "dashboard" | "pulse") | No | Filter by model type. Valid values: 'card', 'collection', 'dashboard', 'pulse' | | `archived` | string | No | Filter by archived status. Must be a valid boolean string ('true' or 'false') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Tree **Slug:** `METABASE_GET_API_COLLECTION_TREE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `shallow` | boolean | No | When true, returns only direct children; when false, returns the full tree with nested children | | `collection_id` | string | No | Filters the tree to show only the specified collection and its children | | `exclude_archived` | boolean | No | When true, excludes archived collections from the response | | `exclude_other_user_collections` | boolean | No | When true, excludes other users' personal collections from the response | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Databases **Slug:** `METABASE_GET_API_DATABASE` DEPRECATED: Use METABASE_LIST_DATABASES instead for a concise, LLM-friendly response. Retrieves all Database instances configured in Metabase with full detail including connection info. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Autocomplete Suggestions **Slug:** `METABASE_GET_API_DATABASE_ID_AUTOCOMPLETE_SUGGESTIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID to get autocomplete suggestions for. This is the unique identifier of the database in Metabase. | | `prefix` | string | Yes | Non-blank string prefix to match against table and field names. The autocomplete will return suggestions that start with this prefix. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Metadata **Slug:** `METABASE_GET_API_DATABASE_ID_METADATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID to retrieve metadata from. This is the unique identifier for the database in Metabase. | | `include_hidden` | boolean | No | Include hidden tables and fields in the response. By default, only non-hidden tables and fields are returned. Set to true to include hidden entities. | | `include_editable_data_model` | boolean | No | Only return tables for which the current user has data model editing permissions. Requires Enterprise Edition and advanced-permissions feature. If user has block permissions, only DB name, ID and tables will be returned with no additional metadata. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Virtual Database Datasets **Slug:** `METABASE_GET_API_DATABASE_VIRTUAL_DB_DATASETS` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `virtual_db` | integer | Yes | The virtual database identifier. Use -1337 for the Saved Questions virtual database, which allows treating saved questions as data sources. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Audit Info **Slug:** `METABASE_GET_API_EE_AUDIT_APP_USER_AUDIT_INFO` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Billing API Version **Slug:** `METABASE_GET_API_EE_BILLING` Tool to retrieve the billing API version information for the Metabase Enterprise Edition instance. Use when you need to check the billing API version. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource Dependents **Slug:** `METABASE_GET_API_EE_DEPENDENCIES_GRAPH_DEPENDENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the resource, must be an integer greater than zero | | `type` | string ("table" | "card" | "snippet" | "transform" | "dashboard" | "document" | "sandbox" | "segment") | Yes | Type of the resource to query dependencies for | | `dependent_type` | string ("table" | "card" | "snippet" | "transform" | "dashboard" | "document" | "sandbox" | "segment") | Yes | Type of dependents to retrieve. Filters the results to only include dependents of this specific type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Embedding Hub Checklist **Slug:** `METABASE_GET_API_EE_EMBEDDING_HUB_CHECKLIST` Tool to retrieve the embedding hub checklist status for Metabase Enterprise Edition. Use when you need to check the progress of embedding setup steps. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current Remote Sync Task **Slug:** `METABASE_GET_API_EE_REMOTE_SYNC_CURRENT_TASK` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Stale Data By ID **Slug:** `METABASE_GET_API_EE_STALE_ID` Tool to retrieve stale data information by ID from Metabase Enterprise Edition. Use when you need to fetch details about stale resources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the stale resource to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Uploaded Tables **Slug:** `METABASE_GET_API_EE_UPLOAD_MANAGEMENT_TABLES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Field Related Entities **Slug:** `METABASE_GET_API_FIELD_ID_RELATED` Tool to retrieve related entities for a Metabase field. Use when you need to get the parent table, related segments, metrics, and other fields from the same table for a specific field ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the field to get related entities for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Field Values **Slug:** `METABASE_GET_API_FIELD_ID_SEARCH_SEARCH_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The field ID to search within. This is the primary field identifier in Metabase. | | `limit` | integer | No | Optional maximum number of results to return. If not specified, the API will use its default limit. Must be a positive integer greater than zero if provided. | | `value` | string | Yes | Non-blank string to search for. The API will return values that start with this string. Used for autocomplete or type-ahead search functionality. | | `search_id` | integer | Yes | The search field ID. This is the field whose values will be matched and returned in the search results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Field Values **Slug:** `METABASE_GET_API_FIELD_ID_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The field ID to retrieve values for. This should be a valid field ID from the Metabase database. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Glossary **Slug:** `METABASE_GET_API_GLOSSARY` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User Login History **Slug:** `METABASE_GET_API_LOGIN_HISTORY_CURRENT` Tool to retrieve login history for the currently authenticated user. Use when you need to audit or review login activity. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Model Index Values **Slug:** `METABASE_GET_API_MODEL_INDEX` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `model_id` | integer | Yes | The ID of the model to retrieve index values for. Value must be an integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Model Index Details **Slug:** `METABASE_GET_API_MODEL_INDEX_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the ModelIndex record to retrieve. Must be an integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get all native query snippets **Slug:** `METABASE_GET_API_NATIVE_QUERY_SNIPPET` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Native Query Snippet by ID **Slug:** `METABASE_GET_API_NATIVE_QUERY_SNIPPET_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the native query snippet to retrieve. Must be a valid integer identifier for an existing snippet. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Notifications **Slug:** `METABASE_GET_API_NOTIFICATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | No | Return all notifications for a card. Filters notifications associated with the specified card/question ID. | | `creator_id` | integer | No | Filter by notification's creator id. Only returns notifications created by the specified user. | | `recipient_id` | integer | No | Return all notifications that the user is the recipient. Filters by the recipient user ID. | | `include_inactive` | boolean | No | Set to true to includes inactive notifications. By default, only active notifications are returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Public Card by UUID **Slug:** `METABASE_GET_API_PUBLIC_CARD_UUID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uuid` | string | Yes | The public UUID of the card. This is a unique identifier that allows access to the card without authentication when public sharing is enabled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Public oEmbed Metadata **Slug:** `METABASE_GET_API_PUBLIC_OEMBED` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | A non-blank string URL to a public Metabase resource (e.g., dashboard or question). The URL must point to a publicly accessible Metabase item. | | `format` | string | No | Output format, must be 'json' if provided. Defaults to JSON if not specified. | | `maxwidth` | integer | No | Maximum width for embedded content in pixels. The oEmbed provider will respect this constraint when generating embed code. | | `maxheight` | integer | No | Maximum height for embedded content in pixels. The oEmbed provider will respect this constraint when generating embed code. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Public Pivot Card Query **Slug:** `METABASE_GET_API_PUBLIC_PIVOT_CARD_UUID_QUERY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uuid` | string | Yes | The public UUID of the pivot card to query. This is a unique identifier that allows access to the card without authentication. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Pulses **Slug:** `METABASE_GET_API_PULSE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `archived` | boolean | No | If true, returns archived pulses. If false or omitted, returns non-archived pulses. Must be a valid boolean. | | `dashboard_id` | integer | No | Filter pulses by dashboard ID. Returns only pulses associated with the specified dashboard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pulse Form Input Configuration **Slug:** `METABASE_GET_API_PULSE_FORM_INPUT` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pulse by ID **Slug:** `METABASE_GET_API_PULSE_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the pulse to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pulse Preview Card **Slug:** `METABASE_GET_API_PULSE_PREVIEW_CARD_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to preview in pulse email format | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pulse Preview Card Info **Slug:** `METABASE_GET_API_PULSE_PREVIEW_CARD_INFO_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to get preview information for in pulse email format | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Revision by ID and Entity **Slug:** `METABASE_GET_API_REVISION` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The numeric ID of the entity to retrieve revisions for. Must be an integer greater than zero | | `entity` | string ("card" | "dashboard" | "document" | "segment") | Yes | The entity type of the revision. Must be one of: card, dashboard, document, segment | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Entity Revision History **Slug:** `METABASE_GET_API_REVISION_ENTITY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The numeric ID of the entity to get revision history for | | `entity` | string | Yes | The entity type to get revision history for. Valid values are: 'dashboard', 'card', 'metric', or 'segment' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Metabase objects **Slug:** `METABASE_GET_API_SEARCH` Tool to search Cards, Dashboards, Collections, Tables, Databases, and Pulses for a substring. Use when you need to find Metabase objects by name or search across multiple object types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Search query substring to search for within Cards, Dashboards, Collections, Tables, Databases, and Pulses. May be nil or a non-blank string. | | `models` | array | No | Array of model types to search within. Valid values include: dashboard, metric, segment, card, collection, table, pulse, database. If omitted, searches all model types. | | `archived` | boolean | No | Filter by archived status. If true, returns archived items. If false, returns non-archived items. If omitted, behavior depends on Metabase version. | | `table_db_id` | integer | No | Filter to specific database ID. Limits search results for tables, cards, and models to the specified database. Must be an integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Search Weights **Slug:** `METABASE_GET_API_SEARCH_WEIGHTS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Segments **Slug:** `METABASE_GET_API_SEGMENT` Tool to retrieve all segments from Metabase. Use when you need to list all available segments or filter definitions for tables. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Password Reset Token **Slug:** `METABASE_GET_API_SESSION_PASSWORD_RESET_TOKEN_VALID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `token` | string | Yes | Password reset token to validate. This token is typically sent to users via email when they request a password reset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Session Properties **Slug:** `METABASE_GET_API_SESSION_PROPERTIES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card Table Foreign Keys **Slug:** `METABASE_GET_API_TABLE_CARD_ID_FKS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The card ID (saved question ID) for which to retrieve foreign key information. Must be a positive integer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card Virtual Table Query Metadata **Slug:** `METABASE_GET_API_TABLE_CARD_ID_QUERY_METADATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The card ID to retrieve query metadata for. This is the ID of the saved question/card that defines the virtual table. | | `include_sensitive_fields` | boolean | No | By passing include_sensitive_fields=true, information about sensitive Fields will be returned. Use this when you need complete field metadata including sensitive fields. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Timelines **Slug:** `METABASE_GET_API_TIMELINE` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Timelines **Slug:** `METABASE_GET_API_TIMELINE_COLLECTION_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the collection to fetch timelines for. This is the unique identifier for the collection in Metabase. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Root Collection Timelines **Slug:** `METABASE_GET_API_TIMELINE_COLLECTION_ROOT` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeline Event **Slug:** `METABASE_GET_API_TIMELINE_EVENT_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the timeline event to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeline by ID **Slug:** `METABASE_GET_API_TIMELINE_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the timeline to fetch | | `include` | string | No | Set to 'events' to include unarchived events on the timeline | | `archived` | boolean | No | Set to true to return all events (both archived and unarchived). Only applies when include='events' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User **Slug:** `METABASE_GET_API_USER_CURRENT` Tool to retrieve information about the currently authenticated user. Use when you need to get the current user's profile, permissions, and account details. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User by ID **Slug:** `METABASE_GET_API_USER_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The user ID to fetch. Must be a valid Metabase user identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Key-Value by Namespace **Slug:** `METABASE_GET_API_USER_KEY_VALUE_NAMESPACE_NAMESPACE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `namespace` | string | Yes | The namespace identifier for user key-value storage. Used to retrieve all key-value pairs within this namespace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Recipients **Slug:** `METABASE_GET_API_USER_RECIPIENTS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Random Security Token **Slug:** `METABASE_GET_API_UTIL_RANDOM_TOKEN` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Dashboard **Slug:** `METABASE_GET_AUTOMAGIC_DASHBOARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `show` | string | No | Optional query parameter to control what is shown in the dashboard | | `entity` | string ("table" | "segment" | "adhoc" | "database" | "card") | Yes | The entity type for which to generate the automagic dashboard. Valid values: 'table', 'segment', 'adhoc', 'database', 'card' | | `entity_id_or_query` | string | Yes | The ID of the entity (numeric for most entities) or a valid query string for adhoc queries | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Dashboard Cell Analysis **Slug:** `METABASE_GET_AUTOMAGIC_DASHBOARDS_CELL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `show` | string | No | Optional display options parameter to control what information is shown in the dashboard | | `entity` | string | Yes | The entity type to analyze. Valid values: 'table', 'database', 'field', 'segment', 'question', 'adhoc' | | `cell_query` | string | Yes | Base64-encoded JSON query object in MBQL format defining the cell to analyze. The query should be base64-encoded and contain fields like 'database', 'query' with 'source-table' and 'aggregation' | | `entity_id_or_query` | string | Yes | The entity ID (numeric) or encoded query string identifying the entity to analyze | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Dashboards Compare **Slug:** `METABASE_GET_AUTOMAGIC_DASHBOARDS_COMPARE` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string ("table" | "segment" | "adhoc") | Yes | Entity type. | | `comparison_entity` | string ("table" | "segment" | "adhoc") | Yes | Comparison entity type. | | `entity_id_or_query` | string | Yes | The ID of the entity (e.g., table ID like '1') or a query string | | `comparison_entity_id_or_query` | string | Yes | The ID of the comparison entity (e.g., table ID like '3') or a query string | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get automagic dashboard by rule **Slug:** `METABASE_GET_AUTOMAGIC_DASHBOARDS_RULE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string | Yes | The entity type (e.g., 'table', 'segment', or 'adhoc'). Specifies what kind of data source to generate the dashboard from. | | `prefix` | string | Yes | The rule prefix for the dashboard template. This determines which category of dashboard rules to use (e.g., 'GenericTable', 'GenericSegment'). | | `dashboard_template` | string | Yes | The name of the dashboard template to use. This specifies which automagic dashboard layout to apply (e.g., 'Correlations', 'Overview', 'Drilldown'). | | `entity_id_or_query` | string | Yes | The ID of the entity or a query string. For tables, this is typically a numeric ID; for adhoc queries, this can be a base64-encoded query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Dashboard Cell Rule Analysis **Slug:** `METABASE_GET_AUTOMAGIC_DASH_ENTITY_CELL_QUERY_RULE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string | Yes | Entity type for the automagic dashboard. Valid values: 'table', 'question', 'metric', 'field', 'database', 'segment', 'adhoc'. Specifies the type of Metabase entity to analyze | | `prefix` | string | Yes | Template prefix/subdirectory name defining the dashboard template category. Common values include 'GenericTable', 'TransactionTable', 'UserTable', 'EventTable'. This corresponds to template directories in Metabase's automagic dashboard resources | | `cell_query` | string | Yes | Base64-encoded JSON query object defining the cell to analyze. Must be valid base64-encoded JSON containing query specifications like breakout fields. Example: 'eyJicmVha291dCI6W1siZmllbGQiLDEsbnVsbF1dfQ==' represents a breakout query | | `dashboard_template` | string | Yes | Dashboard template name from the prefix subdirectory. Common templates include 'Correlations', 'Overview', 'Details'. This corresponds to YAML template files defining the dashboard structure and visualizations | | `entity_id_or_query` | string | Yes | Entity ID or encoded query identifier. For standard entities (table, database, field, segment, question), provide their numeric ID (e.g., '1', '42'). For adhoc queries, provide the encoded query string | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Dashboard Query Metadata **Slug:** `METABASE_GET_AUTOMAGIC_DASH_ENTITY_QUERY_METADATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string | Yes | Entity type for automagic dashboard. Valid values: table, segment, adhoc, question, metric, field | | `entity_id_or_query` | string | Yes | Entity ID (numeric) or base64-encoded query definition | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card Dashboards **Slug:** `METABASE_GET_CARD_DASHBOARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to get dashboards for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card Query Metadata **Slug:** `METABASE_GET_CARD_QUERY_METADATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card (saved question) to retrieve query metadata for. Use this to get comprehensive metadata about the card's database structure, tables, and fields. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card Series **Slug:** `METABASE_GET_CARD_SERIES` 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'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to fetch compatible series for | | `query` | string | No | Search query to filter cards by name or other attributes | | `last_cursor` | integer | No | The ID of the last card from the previous page to fetch the next page. Used for pagination | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automagic Comparison Dashboard **Slug:** `METABASE_GET_COMPARE_AUTOMAGIC_DASHBOARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string ("table" | "question" | "segment" | "adhoc") | Yes | Entity type for the base dashboard - can be 'table', 'question', 'segment', or 'adhoc' | | `cell_query` | string | Yes | Query defining the cell - must be base64 encoded JSON. For example: eyJ0eXBlIjoiY2VsbCJ9 | | `comparison_entity` | string ("table" | "segment" | "adhoc") | Yes | Comparison entity type - can be 'table', 'segment', or 'adhoc' | | `entity_id_or_query` | string | Yes | ID or query for the entity. Numeric ID for table/question/segment, or query string for adhoc | | `comparison_entity_id_or_query` | string | Yes | ID or query for the comparison entity. Numeric ID for table/segment, or query string for adhoc | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard by ID **Slug:** `METABASE_GET_DASHBOARD_BY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The dashboard ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Dashboard Parameter Values **Slug:** `METABASE_GET_DASHBOARD_PARAMS_SEARCH` Tool to fetch possible values of a dashboard parameter that contain the search query. Use when you need to search or filter parameter values for a specific dashboard parameter. The parameter must be linked to a text field (not DateTime or other non-text types). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Dashboard ID to search parameter values in. | | `query` | string | Yes | Search query string to match parameter values. Returns values that contain this query string. | | `param_key` | string | Yes | Parameter ID (e.g., '9d9cddd4') - must be linked to a text field. This is the unique identifier for the dashboard parameter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Query Metadata **Slug:** `METABASE_GET_DASHBOARD_QUERY_METADATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dashboard_id` | integer | Yes | The ID of the dashboard to get query metadata for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Related Entities **Slug:** `METABASE_GET_DASHBOARD_RELATED` Tool to retrieve related entities for a Metabase dashboard. Use when you need to find questions/cards that are related to a specific dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The dashboard ID to get related entities for. Must be a valid dashboard identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database By ID **Slug:** `METABASE_GET_DATABASE_BY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the database to retrieve | | `include` | string ("tables" | "tables.fields") | No | Optional parameter to include related data. Use 'tables' to include tables belonging to the database, or 'tables.fields' to include tables and their fields | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Card Autocomplete Suggestions **Slug:** `METABASE_GET_DATABASE_CARD_AUTOCOMPLETE_SUGGESTIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID for which to retrieve card autocomplete suggestions | | `query` | string | Yes | Search query prefix to filter card suggestions. Returns cards matching this prefix. Must be a non-blank string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Datasets **Slug:** `METABASE_GET_DATABASE_DATASETS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `virtual_db` | integer | Yes | The virtual database ID. Use -1337 for the Saved Questions virtual database, which contains models and metrics created from saved questions. | | `schema_name` | string | Yes | The schema name within the virtual database. Common values include 'Examples' and 'Everything else'. This represents the collection or grouping of saved questions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Fields **Slug:** `METABASE_GET_DATABASE_FIELDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the database to retrieve fields from | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Healthcheck **Slug:** `METABASE_GET_DATABASE_HEALTHCHECK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The database ID to check health for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Schemas **Slug:** `METABASE_GET_DATABASE_SCHEMAS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The database identifier. This is the unique ID of the database in Metabase for which to retrieve schemas. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Settings Available **Slug:** `METABASE_GET_DATABASE_SETTINGS_AVAILABLE` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The database ID to retrieve settings availability for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Database Syncable Schemas **Slug:** `METABASE_GET_DATABASE_SYNCABLE_SCHEMAS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The database identifier. This is the unique ID of the database in Metabase for which to retrieve syncable schemas. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Field Remapping **Slug:** `METABASE_GET_FIELD_REMAPPING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The field identifier. This is the unique ID of the field in Metabase. | | `limit` | integer | No | Maximum number of results to return. Must be a valid integer greater than zero. If not specified, returns all matching results. | | `value` | string | Yes | The value to search for in the remapped field. This is the value you want to find mappings for. | | `remapped_id` | integer | Yes | The field to fetch remapped values from. This is the ID of the field containing the human-readable display values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Field Summary **Slug:** `METABASE_GET_FIELD_SUMMARY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The Field ID to get summary statistics for. This is the unique identifier of the field in Metabase. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Most Recently Viewed Dashboard **Slug:** `METABASE_GET_MOST_RECENTLY_VIEWED_DASHBOARD` Tool to retrieve the most recently viewed dashboard for the authenticated user. Use when you need to check what dashboard the user last accessed. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard HTML Preview **Slug:** `METABASE_GET_PULSE_PREVIEW_DASHBOARD` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the dashboard to preview | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Table By ID **Slug:** `METABASE_GET_TABLE_BY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the table to retrieve. This should be a valid table ID from the Metabase database. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Table Data **Slug:** `METABASE_GET_TABLE_DATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `table_id` | integer | Yes | The ID of the table to retrieve data from | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Table Foreign Keys **Slug:** `METABASE_GET_TABLE_FKS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the table to retrieve foreign keys for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Table Query Metadata **Slug:** `METABASE_GET_TABLE_QUERY_METADATA` Tool to get metadata about a Table useful for running queries. Returns DB, fields, field FKs, and field values. Deprecated: Use METABASE_GET_TABLE_SCHEMA instead — it provides a more concise, LLM-friendly output with FK resolution and supports lookup by table name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The table ID to retrieve query metadata for. This is the unique identifier for the table in Metabase. | | `include_hidden_fields` | boolean | No | Include any hidden Fields in the response. Defaults to false if not specified. | | `include_sensitive_fields` | boolean | No | Include any sensitive Fields in the response. Defaults to false if not specified. | | `include_editable_data_model` | boolean | No | When true, checks that the current user has write permissions for the table's data model. When false, checks that they have data access permissions. Defaults to false if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Table Schema **Slug:** `METABASE_GET_TABLE_SCHEMA` Gets column names, types, and foreign key relationships for a Metabase table. Use this before writing queries to know exact column names and types. Accepts either a table_id directly, or database_id + table_name to look up the table. Discovery chain: METABASE_LIST_DATABASES → METABASE_LIST_TABLES → METABASE_GET_TABLE_SCHEMA → METABASE_POST_API_DATASET. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `table_id` | integer | No | The Metabase table ID. Use METABASE_LIST_TABLES to find table IDs. Either table_id or (database_id + table_name) must be provided. | | `table_name` | string | No | Table name to look up (requires database_id). Case-insensitive matching is used. Optionally prefix with schema: 'public.users' or just 'users'. | | `database_id` | integer | No | The database ID (required when using table_name instead of table_id). Use METABASE_LIST_DATABASES to find database IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Key-Value Setting **Slug:** `METABASE_GET_USER_KEY_VALUE` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | Yes | The key within the namespace (e.g., 'download_format_preference', 'theme'). This is the specific setting or value identifier. | | `namespace` | string | Yes | The namespace for the key-value pair (e.g., 'last_download_format', 'user_preferences'). Namespaces organize key-value pairs into logical groups. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Databases **Slug:** `METABASE_LIST_DATABASES` Lists all databases configured in Metabase with essential info: ID, name, and engine. Use this first to discover available database IDs before running queries or listing tables. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include_tables` | boolean | No | Whether to include the list of table names for each database. Set to true when you need to discover which tables exist. Adds one extra API call per database, so leave false if you only need database IDs and names. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tables **Slug:** `METABASE_LIST_TABLES` Lists all tables in a Metabase database with their IDs, names, and schemas. Use this after METABASE_LIST_DATABASES to discover available tables before querying. For detailed column information, use METABASE_GET_TABLE_SCHEMA next. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `database_id` | integer | Yes | The database ID to list tables from. Use METABASE_LIST_DATABASES first to discover available database IDs. | | `schema_name` | string | No | Filter tables to a specific schema (e.g., 'public', 'dbo'). If not provided, tables from all schemas are returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Parameter Remapping **Slug:** `METABASE_METABASE_GET_API_DASH_ID_PARAMS_PARAM_KEY_REMAPPING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Dashboard ID. The unique identifier of the dashboard containing the parameter. | | `value` | string | Yes | The value to get remapping for. This is the parameter value that needs to be remapped to human-readable labels or alternative representations. | | `param_key` | string | Yes | Parameter ID/key from dashboard's parameters array. The unique identifier or key of the parameter within the dashboard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Parameter Values **Slug:** `METABASE_METABASE_GET_API_DASH_ID_PARAMS_PARAM_KEY_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Dashboard ID to fetch parameter values from | | `param_key` | string | Yes | Parameter key/ID from dashboard parameters. This is the unique identifier for a specific parameter on the dashboard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Dashboard Subscription **Slug:** `METABASE_METABASE_POST_API_EE_METABOT_TOOLS_CREATE_DASH_SUB` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Arguments containing dashboard_id, email, and schedule configuration | | `conversation_id` | string | Yes | UUID for the conversation context. Must be a properly formatted UUID string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Details **Slug:** `METABASE_METABASE_POST_API_EE_METABOT_TOOLS_GET_DASH_DETAILS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Arguments object containing dashboard_id parameter | | `profile_id` | string | No | Optional profile identifier. Can be null. | | `conversation_id` | string | Yes | UUID for the conversation context. Required to retrieve dashboard details associated with a conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Document Details via Metabot **Slug:** `METABASE_METABASE_POST_API_EE_METABOT_TOOLS_GET_DOC_DETAILS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Arguments containing the document_id to retrieve | | `conversation_id` | string | Yes | A valid UUID for the conversation. Used to track and associate the document request with a specific conversation session. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Record Recent Activity **Slug:** `METABASE_POST_API_ACTIVITY_RECENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `model` | string ("card" | "dataset" | "metric" | "dashboard" | "table" | "collection" | "document") | Yes | The type of item being accessed. Must be one of: card, dataset, metric, dashboard, table, collection, or document. | | `context` | string | Yes | The context of the activity. Currently only 'selection' is supported. | | `model_id` | integer | Yes | The ID of the item being accessed. Must be a positive integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Card **Slug:** `METABASE_POST_API_CARD` Tool to create a new Metabase card (question or model). Use when you need to create a new query, report, or visualization in Metabase. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the card | | `display` | string | Yes | Display type for visualization (e.g., table, bar, line, pie, scalar, area) | | `description` | string | No | Description of the card | | `collection_id` | integer | No | ID of collection to place card in | | `dataset_query` | object | Yes | Query definition in MBQL or native SQL format. Must include 'database' (integer ID), 'type' (string, e.g., 'query' or 'native'), and 'query' object (for MBQL queries with 'source-table' field) or 'native' object (for SQL queries with 'query' field) | | `result_metadata` | array | No | Metadata about query results | | `metadata_checksum` | string | No | Checksum of metadata | | `collection_position` | integer | No | Position within collection | | `visualization_settings` | object | No | Settings for visualization display. Can be an empty object {} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute Card Query (Deprecated) **Slug:** `METABASE_POST_API_CARD_CARD_ID_QUERY` DEPRECATED: Use METABASE_METABASE_CREATE_CARD_QUERY1 instead. 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | Yes | The ID of the saved card/question to query | | `parameters` | array | No | Optional array of parameter objects for filtering. Each parameter can specify type, value, and target for template tag variables. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Move Cards to Collection **Slug:** `METABASE_POST_API_CARD_COLLECTIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_ids` | array | Yes | Array of card IDs (integers greater than zero) to move to the specified collection | | `collection_id` | string | Yes | Target collection ID (integer greater than zero) to move cards into, or null to remove cards from all collections | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Card **Slug:** `METABASE_POST_API_CARD_ID_COPY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to copy | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Card Dashboard Associations **Slug:** `METABASE_POST_API_CARDS_DASHBOARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_ids` | array | Yes | List of card IDs to retrieve dashboard associations for. Each ID must be an integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Move Cards **Slug:** `METABASE_POST_API_CARDS_MOVE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_ids` | array | Yes | List of card IDs to move. Each ID must be an integer greater than zero. | | `collection_id` | string | Yes | ID of the target collection to move cards into. Pass null to remove cards from any collections. Must be an integer greater than zero if provided. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Collection **Slug:** `METABASE_POST_API_COLLECTION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Collection name (non-blank string) | | `color` | string | Yes | Hex color code for the collection (must match pattern #[0-9A-Fa-f]{6}) | | `parent_id` | integer | No | Parent collection ID for nested collections (must be greater than 0) | | `description` | string | No | Collection description (non-blank string if provided) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Dashboard **Slug:** `METABASE_POST_API_DASHBOARD` Tool to create a new Metabase dashboard. Use when you need to create a new dashboard for organizing and displaying visualizations and reports. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Dashboard name. Must be a non-blank string. | | `parameters` | array | No | Dashboard filter parameters. Array of parameter objects that define filters users can apply to the dashboard. | | `description` | string | No | Dashboard description. Provides context about the dashboard's purpose and content. | | `collection_id` | integer | No | ID of collection to place dashboard in. If not specified, dashboard is created in root collection. | | `collection_position` | integer | No | Position within the collection. Determines the display order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute Dataset Query **Slug:** `METABASE_POST_API_DATASET` 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'). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("native" | "query") | Yes | Query type: 'native' for raw SQL queries, 'query' for MBQL (Metabase Query Language) queries | | `query` | object | No | MBQL (Metabase Query Language) query structure. | | `native` | object | No | Native SQL query structure. | | `database` | integer | Yes | The database ID to execute the query against | | `parameters` | array | No | Optional query parameters for parameterized queries | | `constraints` | object | No | Query execution constraints. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Convert Query to Native SQL **Slug:** `METABASE_POST_API_DATASET_NATIVE` Tool to convert a Metabase query to native SQL format. Use when you need to get the formatted native SQL representation of a query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | Query type - must be set to 'native' for native SQL queries | | `native` | object | Yes | Object containing the native SQL query string and template tags for parameters | | `database` | integer | Yes | Database ID - must be a positive integer representing the target database | | `parameters` | array | No | Array of parameter values for the query. Use empty array [] for queries without parameters | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remap Dataset Parameter Value **Slug:** `METABASE_POST_API_DATASET_PARAMETER_REMAPPING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | The value to remap. Can be string, number, boolean, or null | | `parameter` | object | Yes | A parameter object with id and type keys specifying which parameter to remap | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Parameter Values **Slug:** `METABASE_POST_API_DATASET_PARAMETER_VALUES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `field_ids` | array | Yes | Array of field IDs to retrieve parameter values from. Must be non-empty array of positive integers | | `parameter` | object | Yes | A parameter object with id and type keys specifying which parameter to fetch values for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute Pivot Table Query **Slug:** `METABASE_POST_API_DATASET_PIVOT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | Query type, typically 'query' for MBQL queries | | `query` | object | Yes | Query object containing source-table, aggregation, and breakout fields for pivot table generation. Must include 'source-table' (table ID), 'aggregation' (list of aggregation functions like [['count']]), and 'breakout' (list of fields to break out by). | | `database` | integer | Yes | Database ID to query against | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Query Metadata **Slug:** `METABASE_POST_API_DATASET_QUERY_METADATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | The query type. Use 'query' for MBQL queries with source-table, or 'native' for raw SQL queries. | | `query` | object | Yes | The query object containing the query specification. For MBQL queries, include 'source-table' (integer table ID). For native queries, include the SQL string in a 'native' field. | | `database` | integer | Yes | The database ID to query metadata from. This is the unique identifier for the database in Metabase. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Snippet Dependencies **Slug:** `METABASE_POST_API_EE_DEPENDENCIES_CHECK_SNIPPET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The snippet ID to check dependencies for. Must be an integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Filter Records **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_FILTER_RECORDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Arguments object containing the data_source and filters to apply | | `conversation_id` | string | Yes | UUID for the metabot conversation context. Required to maintain conversation state. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Insights **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_GENERATE_INSIGHTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Contains the 'for' property specifying what to generate insights for (e.g., table_id) | | `conversation_id` | string | Yes | Valid UUID for the conversation context. Must be a properly formatted UUID string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_GET_CURRENT_USER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_id` | string | No | Optional profile identifier for the user. Can be null or omitted. | | `conversation_id` | string | Yes | UUID for the conversation context. Required to retrieve the current user information within a metabot conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Query Details **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_GET_QUERY_DETAILS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | object | Yes | Query object containing database, type, and query details. Structure: {"database": , "type": "query", "query": {"source-table": }} | | `profile_id` | string | No | Optional profile ID for the query execution context | | `conversation_id` | string | Yes | UUID of the conversation. Must be a valid UUID in format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Snippet Details **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_GET_SNIPPET_DETAILS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Arguments object containing the snippet_id to retrieve | | `profile_id` | string | No | Optional profile identifier for the metabot conversation | | `conversation_id` | string | Yes | A valid UUID string for the metabot conversation context. This is required to maintain conversation state. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Metabot Snippets **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_GET_SNIPPETS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `conversation_id` | string | Yes | UUID for the conversation context. Required to retrieve snippets associated with a conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Table Details **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_GET_TABLE_DETAILS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Arguments object containing table_id and optional parameters for customizing the response | | `profile_id` | string | No | Optional profile identifier for the metabot conversation context | | `conversation_id` | string | Yes | A valid UUID string for the metabot conversation context. This is required to maintain conversation state and track the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Datasource via Metabot **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_QUERY_DATASOURCE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arguments` | object | Yes | Query arguments containing datasource identifier (table_id or model_id) and optional query parameters (limit, fields, filters, etc.) | | `conversation_id` | string | Yes | UUID identifying the conversation context. Required for tracking the metabot interaction | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Metabot Search **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_SEARCH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Integer controlling maximum number of results to return (default: 50) | | `weights` | object | No | Weight object for controlling search result scoring. | | `created_at` | string | No | String for filtering by creation date in ISO 8601 format | | `database_id` | integer | No | Integer to scope search to specific database | | `entity_types` | array | No | Array filtering by entity type: table, model, question, dashboard, metric, database, or transform | | `term_queries` | array | No | Array of string-based search terms to match against entity names and descriptions | | `last_edited_at` | string | No | String for filtering by last edit date in ISO 8601 format | | `conversation_id` | string | Yes | Valid UUID for the conversation. Required for all metabot search operations. | | `semantic_queries` | array | No | Array of string queries for semantic/natural language search | | `search_native_query` | boolean | No | Boolean to include native SQL queries in search (default: false) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Metabase Items (Metabot V2) **Slug:** `METABASE_POST_API_EE_METABOT_TOOLS_SEARCH_V2` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of search results to return. Defaults to 50 if not specified | | `weights` | object | No | Optional weighting factors for different search criteria to customize result ranking | | `created_at` | string | No | Filter results by creation date. Format depends on API requirements | | `database_id` | integer | No | Filter results to only include items from a specific database ID | | `entity_types` | array | No | Filter results to only include specific entity types. If not provided, all types are searched | | `term_queries` | array | No | Array of keyword search terms to find matching items by name or content. Use for traditional keyword-based search | | `last_edited_at` | string | No | Filter results by last edit date. Format depends on API requirements | | `conversation_id` | string | No | UUID string identifying the conversation context for the search. Used to maintain search context across multiple queries | | `semantic_queries` | array | No | Array of semantic/natural language queries for AI-powered search. Use for more contextual searches | | `search_native_query` | boolean | No | Whether to include native SQL queries in the search. Defaults to false | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Current Remote Sync Task **Slug:** `METABASE_POST_API_EE_REMOTE_SYNC_CURRENT_TASK_CANCEL` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Translate Entity IDs **Slug:** `METABASE_POST_API_EID_TRANSLATION_TRANSLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity_ids` | object | Yes | Map of entity types to arrays of entity IDs. Entity IDs must be 21 characters long. Keys are entity types (card, dashboard, etc.) and values are arrays of entity ID strings. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rescan Field Values **Slug:** `METABASE_POST_API_FIELD_ID_RESCAN_VALUES` 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'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the field to rescan values for. Field must be eligible for FieldValues (typically fields with 'list' has_field_values setting). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Glossary Entry **Slug:** `METABASE_POST_API_GLOSSARY` Tool to create a new glossary entry in Metabase. Use when you need to add a new term and its definition to the glossary. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `term` | string | Yes | The glossary term name (must be a non-blank string) | | `definition` | string | Yes | The definition of the glossary term | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Model Index **Slug:** `METABASE_POST_API_MODEL_INDEX` Tool to create a new model index in Metabase. Use when you need to enable search functionality on a model by indexing specific fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pk_ref` | array | Yes | Field reference array for the primary key field in format ["field", field_id, options]. The third element can be null or a dict with options. Example: ["field", 9, null] | | `model_id` | integer | Yes | ID of the model/card to create index for. Must be integer greater than zero. | | `value_ref` | array | Yes | Field reference array for the text field to index for search in format ["field", field_id, options]. The third element can be null or a dict with options like source-field. Example: ["field", 48, {"source-field": 11}] | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create native query snippet **Slug:** `METABASE_POST_API_NATIVE_QUERY_SNIPPET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the snippet. Must be unique within the Metabase instance. | | `content` | string | Yes | The SQL code/native query content of the snippet. This is the reusable SQL fragment that can be included in native queries. | | `description` | string | No | Optional description of the snippet to explain its purpose and usage. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Notification **Slug:** `METABASE_POST_API_NOTIFICATION` Tool to create a new notification in Metabase. Use when you need to create notifications for cards or other resources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Payload object containing notification details. For 'notification/card' type, this should include 'card_id' (integer) specifying which card the notification is for | | `payload_type` | string | Yes | Type of notification to create. Common values include 'notification/card' for card-based notifications | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Notification **Slug:** `METABASE_POST_API_NOTIFICATION_SEND` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Notification payload containing card_id, send_once, and send_condition settings | | `handlers` | array | Yes | Array of handler configurations defining how and where to send the notification | | `handler_ids` | array | No | Optional list of specific handler IDs to send to. If not provided, all handlers are used | | `payload_type` | string | Yes | Type of notification payload, typically 'notification/card' for card-based notifications | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Product Feedback **Slug:** `METABASE_POST_API_PRODUCT_FEEDBACK` Tool to submit product feedback to Metabase. Use when you need to send feedback about the product from various sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source` | string | Yes | Source of the feedback - must be a non-blank string indicating where the feedback originated from (e.g., 'api-test', 'web-app', 'mobile-app') | | `comments` | string | No | Feedback comments - optional string field containing the actual feedback text or description | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Pulse **Slug:** `METABASE_POST_API_PULSE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the pulse. Must be a non-blank string | | `cards` | array | Yes | Array of card objects to include in the pulse. Cannot be empty - must contain at least one card | | `channels` | array | Yes | Array of channel configurations for pulse delivery. Cannot be empty - must contain at least one channel | | `creator_id` | integer | Yes | ID of the user creating the pulse. Must be a valid user ID greater than zero | | `parameters` | array | No | List of parameters for the pulse | | `dashboard_id` | integer | No | ID of the dashboard if creating a dashboard-based pulse | | `collection_id` | integer | No | ID of the collection to place the pulse in | | `skip_if_empty` | boolean | No | Whether to skip sending the pulse if results are empty | | `collection_position` | integer | No | Position within the collection | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revert Entity to Previous Revision **Slug:** `METABASE_POST_API_REVISION_REVERT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the entity to revert. Must be an integer greater than zero. | | `entity` | string ("card" | "dashboard" | "document" | "segment") | Yes | The type of entity to revert. Must be one of: 'card' (question), 'dashboard', 'document', or 'segment'. | | `revision_id` | integer | Yes | The ID of the revision to revert to. Must be an integer greater than zero. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Password Reset Email **Slug:** `METABASE_POST_API_SESSION_FORGOT_PASSWORD` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Valid email address for password reset. A reset email will be sent to this address if it exists in the system. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Password Complexity **Slug:** `METABASE_POST_API_SESSION_PASSWORD_CHECK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `password` | string | Yes | The password to validate against current password complexity rules. The endpoint checks if the password meets the configured complexity requirements (weak/normal/strong) and is not in the common passwords list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Bug Report to Slack **Slug:** `METABASE_POST_API_SLACK_BUG_REPORT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `diagnosticInfo` | object | Yes | Diagnostic information for the bug report including browser, version, and system details. This field is required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Timeline **Slug:** `METABASE_POST_API_TIMELINE` Tool to create a new timeline in Metabase. Use when you need to create a timeline for organizing events. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `icon` | string | No | Icon for the timeline. Defaults to 'star' if not provided | | `name` | string | Yes | The name of the timeline (required) | | `default` | boolean | No | Whether this is the default timeline. Defaults to false if not provided | | `archived` | boolean | No | Whether the timeline is archived. Defaults to false if not provided | | `description` | string | No | Optional description of the timeline | | `collection_id` | integer | No | The ID of the collection to associate the timeline with. Use null for root collection. Defaults to null if not provided | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute Dashboard Card Query **Slug:** `METABASE_POST_DASHBOARD_QUERY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `card_id` | integer | Yes | The ID of the card (question) to execute the query for | | `parameters` | array | No | Optional array of parameter values to apply to the query. Each parameter includes type, target, and value fields. | | `dashcard_id` | integer | Yes | The ID of the dashcard (card instance on the dashboard) | | `dashboard_id` | integer | Yes | The ID of the dashboard containing the card | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Action by ID **Slug:** `METABASE_PUT_API_ACTION_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the action to update | | `name` | string | Yes | The name of the action | | `type` | string | Yes | Type of action, e.g., 'query', 'http', or 'implicit' | | `model_id` | integer | Yes | The ID of the model associated with this action | | `database_id` | integer | Yes | The ID of the database for this action | | `description` | string | No | Description of the action | | `dataset_query` | object | Yes | Query definition object with lib/type, database, and stages. Must include database ID and query stages with native SQL or MBQL query | | `visualization_settings` | object | No | Optional visualization settings like confirmMessage and submitButtonLabel | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Bookmark Ordering **Slug:** `METABASE_PUT_API_BOOKMARK_ORDERING` Tool to update the order of bookmarks for the authenticated user. Use when you need to reorder bookmarked cards, dashboards, or collections. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `orderings` | array | Yes | Sequence of bookmark items defining the desired order. Each item specifies the type and ID of a bookmarked item. The order of items in this array determines their display order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Card by ID **Slug:** `METABASE_PUT_API_CARD_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the card to update | | `name` | string | No | Non-blank string for the card name | | `display` | string | No | Display type for the card (e.g., table, bar, line, pie, scalar, area) | | `archived` | boolean | No | Whether the card is archived | | `description` | string | No | String description of the card | | `collection_id` | integer | No | ID of the collection containing this card | | `dataset_query` | object | No | The query definition for the card | | `result_metadata` | array | No | Array of result column metadata maps | | `embedding_params` | object | No | Map of embedding parameters | | `enable_embedding` | boolean | No | Whether embedding is enabled | | `metadata_checksum` | string | No | Checksum for metadata validation | | `collection_position` | integer | No | Position in collection, must be > 0 | | `visualization_settings` | object | No | Map of visualization settings | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Collection by ID **Slug:** `METABASE_PUT_API_COLLECTION_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the collection to update | | `name` | string | No | The name of the collection (must be a non-blank string if provided) | | `color` | string | No | Hex color code matching ^#[0-9A-Fa-f]{6}$ (may be nil). Example: #5C7CFA, #FF6B6B | | `archived` | boolean | No | Archive/unarchive the collection (may be nil) | | `parent_id` | integer | No | Parent collection ID for moving collections (must be > 0 or nil) | | `description` | string | No | The description of the collection (may be nil or a non-blank string) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dashboard Cards **Slug:** `METABASE_PUT_API_DASHBOARD_ID_CARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Dashboard ID to update | | `cards` | array | No | Array of dashboard card objects with properties: id, card_id, size_x, size_y, col, row, series, parameter_mappings. Update positions and sizes of cards on the dashboard. | | `ordered_tabs` | array | No | Array for tab ordering. Specify the order of tabs in the dashboard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Database Configuration **Slug:** `METABASE_PUT_API_DATABASE_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Database ID to update. This is the unique identifier for the database in Metabase. | | `name` | string | Yes | Database name | | `engine` | string | Yes | Database engine type (e.g., h2, postgres, mysql, mongodb, sqlserver) | | `details` | object | Yes | Database connection details object containing connection parameters. For H2: {db: 'file:/path/to/db;USER=user;PASSWORD=pass'}. For Postgres: {host: 'localhost', port: 5432, dbname: 'mydb', user: 'user', password: 'pass'}. Structure varies by engine type. | | `cache_ttl` | integer | No | Cache time-to-live in seconds. Controls how long query results are cached. | | `description` | string | No | Database description | | `is_full_sync` | boolean | No | Whether to perform full synchronization of database metadata | | `auto_run_queries` | boolean | No | Whether to automatically run queries against this database | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Field Metadata **Slug:** `METABASE_PUT_API_FIELD_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the field to update | | `description` | string | No | Field description text. Use this to document what the field represents and how it should be used. | | `display_name` | string | No | The display name for the field. This is how the field will be shown to users in the Metabase UI. | | `semantic_type` | string | No | Semantic type for the field. Common values include: type/Category, type/Latitude, type/Longitude, type/Email, type/URL, type/Number, type/Integer, type/FK (foreign key), type/PK (primary key). | | `visibility_type` | string | No | Controls field visibility in the Metabase UI. Valid values: 'normal' (visible in all contexts), 'details-only' (only visible in detail views), 'hidden' (not visible but queryable), 'retired' (deprecated), 'sensitive' (contains sensitive data). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Glossary Entry by ID **Slug:** `METABASE_PUT_API_GLOSSARY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The unique identifier of the glossary entry to update | | `term` | string | Yes | The updated glossary term name (must be a non-blank string) | | `definition` | string | Yes | The updated definition of the glossary term | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Native Query Snippet by ID **Slug:** `METABASE_PUT_API_NATIVE_QUERY_SNIPPET_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the native query snippet to update. Must be a valid integer identifier for an existing snippet. | | `name` | string | No | The updated name of the snippet. If not provided, the existing name will be retained. | | `content` | string | No | The updated SQL content of the snippet. If not provided, the existing content will be retained. | | `description` | string | No | The updated description of what the snippet does. If not provided, the existing description will be retained. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Pulse by ID **Slug:** `METABASE_PUT_API_PULSE_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the pulse to update | | `name` | string | No | Name of the pulse. Must be a non-blank string | | `cards` | array | No | Array of card objects to include in the pulse. Each card must have id, include_csv, and include_xls | | `archived` | boolean | No | Whether the pulse is archived | | `channels` | array | No | Array of channel configurations for pulse delivery. Each channel must specify channel_type, enabled, schedule_type, and recipients | | `collection_id` | integer | No | ID of the collection to place the pulse in | | `skip_if_empty` | boolean | No | Whether to skip sending the pulse if results are empty | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Search Weights **Slug:** `METABASE_PUT_API_SEARCH_WEIGHTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rrf` | number | No | Reciprocal rank fusion weight. Controls the ranking algorithm for combining multiple search results | | `mine` | number | No | User-owned items weight. Boosts items owned by the current user | | `text` | number | No | Text match weight. Controls scoring for text-based search matches | | `exact` | number | No | Exact match weight. Controls scoring for exact query matches | | `model` | number | No | Model type weight. Affects how models are ranked in search results | | `pinned` | number | No | Pinned items weight. Affects how pinned items appear in search results | | `prefix` | number | No | Prefix match weight. Controls scoring for prefix matches in search queries | | `recency` | number | No | Recency scoring weight. Boosts more recently created or updated items | | `verified` | number | No | Verified items weight. Boosts items that have been verified | | `dashboard` | number | No | Dashboard scoring weight. Affects how dashboards are ranked in search results | | `bookmarked` | number | No | Bookmarked items weight. Affects ranking of items that users have bookmarked | | `view-count` | number | No | View count weight. Boosts items with higher view counts | | `user-recency` | number | No | User-specific recency weight. Boosts items the user has recently viewed or interacted with | | `official-collection` | number | No | Official collection weight. Boosts items in official collections | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Table Metadata **Slug:** `METABASE_PUT_API_TABLE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the table to update. This is the unique identifier for the table in Metabase. | | `caveats` | string | No | Caveats or warnings about the table data. Use this to highlight potential issues, limitations, or important considerations when using this table. | | `description` | string | No | Description of the table. Use this to document what the table contains and how it should be used. | | `display_name` | string | No | Custom display name for the table. This is how the table will be shown to users in the Metabase UI. | | `visibility_type` | string ("normal" | "cruft" | "hidden" | "technical") | No | Visibility setting for the table. 'normal' shows the table everywhere, 'cruft' marks it as low-quality, 'hidden' hides it from most views, 'technical' marks it as a technical table. | | `points_of_interest` | string | No | Notable aspects or interesting features of the table. Use this to highlight useful columns, relationships, or insights. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Table Field Display Order **Slug:** `METABASE_PUT_API_TABLE_ID_FIELDS_ORDER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the table whose field order is being updated. Must be a positive integer. | | `field_ids` | array | Yes | Array of field IDs (integers) representing the desired display order of fields. Each value must be a positive integer. Field IDs can be obtained from GET /api/table/{id}/query_metadata endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Timeline Event by ID **Slug:** `METABASE_PUT_API_TIMELINE_EVENT_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the timeline event to update | | `icon` | string | No | The icon to display for the event (e.g., 'star', 'bell', 'calendar') | | `name` | string | No | The title/name of the event | | `timezone` | string | No | The timezone for the event (e.g., 'UTC', 'America/New_York') | | `timestamp` | string | No | The date/time of the event in ISO 8601 format | | `description` | string | No | Description text for the event | | `time_matters` | boolean | No | Whether the specific time matters or just the date | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Timeline by ID **Slug:** `METABASE_PUT_API_TIMELINE_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the timeline to update | | `icon` | string | No | Icon name for the timeline (e.g., 'star', 'bell') | | `name` | string | No | The name of the timeline | | `default` | boolean | No | Whether this is a default timeline | | `archived` | boolean | No | Whether the timeline is archived | | `description` | string | No | Description of the timeline | | `collection_id` | integer | No | ID of the collection this timeline belongs to | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User by ID **Slug:** `METABASE_PUT_API_USER_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The user ID to update. Must be a valid Metabase user identifier. | | `email` | string | No | Email address of the user. Must be a valid email address if provided. | | `group_ids` | array | No | Array of group IDs that the user should be a member of. Each ID must be greater than 0. | | `last_name` | string | No | Last name of the user. Must be non-blank if provided. | | `first_name` | string | No | First name of the user. Must be non-blank if provided. | | `is_superuser` | boolean | No | Whether the user should have superuser/admin privileges. | | `login_attributes` | object | No | Key-value pairs for additional login attributes. Values can be strings or numbers. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dashboard **Slug:** `METABASE_UPDATE_DASHBOARD` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the dashboard to update | | `name` | string | No | Dashboard name - must be non-blank string if provided. Use this to rename the dashboard | | `tabs` | array | No | List of dashboard tabs. Include when updating tab configuration | | `archived` | boolean | No | Whether the dashboard is archived. Set to true to move dashboard to Trash collection, false to restore it | | `dashcards` | array | No | List of dashboard cards with their configurations. Include the complete array when updating card positions or properties | | `parameters` | array | No | Array of parameter objects for the dashboard. Include this when updating dashboard filters | | `description` | string | No | Dashboard description - may be empty or a string | | `collection_id` | integer | No | Collection ID the dashboard belongs to. Use when moving dashboard to a different collection or when unarchiving | | `enable_embedding` | boolean | No | Whether embedding is enabled for the dashboard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dashboard Cards (Deprecated) **Slug:** `METABASE_UPDATE_DASHBOARD_CARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | The ID of the dashboard to update cards for | | `cards` | array | Yes | Array of dashboard cards. Include all cards to keep (with updates), add new cards with negative IDs, and omit cards to delete them | | `ordered_tabs` | array | No | Array of dashboard tabs in desired order. Only required if dashboard has tabs | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |