Team
Shared credential for production and unattended runs.
Connect Metabase with Hookshot™ and your stack
Metabase is an open-source business intelligence tool that lets you ask questions about your data and visualize answers as charts, graphs, and dashboards.
Tools and triggers
What Agents can do in Metabase
Available tools and events after Metabase is connected.
-
Bulk Move Cards
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.
-
Bulk Move Cards to Collection
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…
-
Cancel Current Remote Sync Task
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.
-
Check Password Complexity
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…
-
Check Snippet Dependencies
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.
-
Convert Query to Native SQL
Tool to convert a Metabase query to native SQL format. Use when you need to get the formatted native SQL representation of a query.
-
Copy Card
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.
-
Copy Dashboard
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…
-
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.
-
Create 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.
-
Create 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.
-
Create Dashboard
Tool to create a new Metabase dashboard. Use when you need to create a new dashboard for organizing and displaying visualizations and reports.
-
Create Dashboard Subscription
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.
-
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.
-
Create Glossary Entry
Tool to create a new glossary entry in Metabase. Use when you need to add a new term and its definition to the glossary.
-
Create 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.
-
Create 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…
-
Create Notification
Tool to create a new notification in Metabase. Use when you need to create notifications for cards or other resources.
-
Create 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.
-
Create Timeline
Tool to create a new timeline in Metabase. Use when you need to create a timeline for organizing events.
-
Delete Action
Tool to delete a Metabase action by its ID. Use when you need to permanently remove an action from the system.
-
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).
-
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.
-
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.
-
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…
-
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.
-
Delete Glossary Entry
Tool to delete a glossary entry from Metabase. Use when you need to permanently remove a glossary entry by its ID.
-
Delete Model Index
Tool to delete a ModelIndex by ID from Metabase. Use when you need to remove a model index from the system.
-
Delete Timeline
Tool to delete a timeline by ID. Use when you need to permanently remove a timeline. Returns success status on completion.
-
Delete Timeline Event
Tool to delete a Metabase timeline event. Use when you need to permanently remove a timeline event from the system.
-
Delete User Key-Value Pair
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.
-
Delete 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…
-
Disable Database Model Persistence
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).
-
Discard Database Field 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.
-
Discard Field 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…
-
Discard Table Field 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…
-
Dismiss Database Sync 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.
-
Execute Dashboard Card 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.
-
Execute Dataset Query
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').
-
Execute Pivot Table Query
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.
-
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.
-
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.
-
Generate Random Security 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.
-
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.
-
Get Action Execute Parameters
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.
-
Get All Alerts
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.
-
Get All Collections
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…
-
Get All Metabase Actions
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…
-
Get All Native Query Snippets
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…
-
Get All Pulses
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.
-
Get All Segments
Tool to retrieve all segments from Metabase. Use when you need to list all available segments or filter definitions for tables.
-
Get All Timelines
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.
-
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.
-
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.
-
Get Automagic Comparison Dashboard
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…
-
Get Automagic Dashboard
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.
-
Get Automagic Dashboard by 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…
-
Get Automagic Dashboard 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…
-
Get Automagic Dashboard Cell Analysis
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…
-
Get Automagic Dashboard Cell Rule Analysis
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…
-
Get Automagic Dashboard 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…
-
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…
-
Get Billing API Version
Tool to retrieve the billing API version information for the Metabase Enterprise Edition instance. Use when you need to check the billing API version.
-
Get Card by 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.
-
Get Card Dashboard Associations
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.
-
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.
-
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…
-
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…
-
Get Card Table Foreign Keys
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…
-
Get Card Virtual Table 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…
-
Get Collection by 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…
-
Get Collection 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.
-
Get Collection Timelines
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.
-
Get 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…
-
Get Current Remote Sync 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…
-
Get Current User
Tool to retrieve information about the currently authenticated user. Use when you need to get the current user's profile, permissions, and account details.
-
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.
-
Get Current User Login History
Tool to retrieve login history for the currently authenticated user. Use when you need to audit or review login activity.
-
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.
-
Get Dashboard 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…
-
Get Dashboard HTML Preview
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.
-
Get Dashboard Parameter 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.
-
Get Dashboard Parameter 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.
-
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.
-
Get Dashboard Related Entities
Tool to retrieve related entities for a Metabase dashboard. Use when you need to find questions/cards that are related to a specific dashboard.
-
Get Database 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.
-
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.
-
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…
-
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…
-
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…
-
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.
-
Get Database 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.
-
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.
-
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…
-
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…
-
Get 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.
-
Get 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.
-
Get Document Details via Metabot
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.
-
Get 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.
-
Get Entity Revision History
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…
-
Get Field Related Entities
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.
-
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…
-
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…
-
Get Field 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…
-
Get Metabot 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.
-
Get Model Index Details
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.
-
Get Model Index Values
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…
-
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.
-
Get Native Query Snippet by 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.
-
Get Notifications
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…
-
Get 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…
-
Get Public Card by 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…
-
Get Public oEmbed Metadata
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.
-
Get Public Pivot Card 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…
-
Get Pulse by 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.
-
Get Pulse Form Input Configuration
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.
-
Get Pulse Preview Card
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.
-
Get Pulse Preview Card Info
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…
-
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…
-
Get Recent Activity 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…
-
Get Resource 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…
-
Get Revision by ID and Entity
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).
-
Get Root Collection
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…
-
Get Root Collection Timelines
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…
-
Get 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…
-
Get 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.
-
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.
-
Get Stale Data by ID
Tool to retrieve stale data information by ID from Metabase Enterprise Edition. Use when you need to fetch details about stale resources.
-
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…
-
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.
-
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…
-
Get Table Foreign Keys
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.
-
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…
-
Get Timeline by 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.
-
Get Timeline Event
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.
-
Get Uploaded 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.
-
Get 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.
-
Get User Bookmarks
Tool to retrieve all bookmarks for the authenticated user. Use when you need to fetch bookmarked cards, dashboards, or collections.
-
Get User by 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.
-
Get User Key-Value by 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…
-
Get User Key-Value Setting
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…
-
Get 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…
-
Get Virtual Database 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).
-
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.
-
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…
-
Metabot 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.
-
Query Datasource via Metabot
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.
-
Record Recent Activity
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…
-
Remap Dataset Parameter Value
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.
-
Rescan Field 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…
-
Rescan Table Field 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…
-
Revert Entity to Previous Revision
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.
-
Run 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…
-
Run Card Query
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.
-
Run Dashboard Pivot DashCard Query
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.
-
Save Dashboard to 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.
-
Search Card Parameter Values
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…
-
Search Dashboard Parameter Values
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…
-
Search Dataset Parameter Values
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.
-
Search Field Values
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…
-
Search Metabase Items (Metabot 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…
-
Search Metabase Objects
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.
-
Send Notification
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).
-
Send Password Reset Email
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…
-
Submit Bug Report to Slack
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'…
-
Submit Product Feedback
Tool to submit product feedback to Metabase. Use when you need to send feedback about the product from various sources.
-
Sync Table 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…
-
Translate Entity IDs
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.
-
Trigger Database Field Values Rescan
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.
-
Trigger Database Schema Sync
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.
-
Unpersist Card
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…
-
Update Action by 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.
-
Update Bookmark Ordering
Tool to update the order of bookmarks for the authenticated user. Use when you need to reorder bookmarked cards, dashboards, or collections.
-
Update Card by 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.
-
Update Collection by 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…
-
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…
-
Update Database Configuration
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.
-
Update Field Metadata
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…
-
Update 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…
-
Update Glossary Entry by 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.
-
Update Native Query Snippet by 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 Pulse by 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.
-
Update 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.
-
Update Table Field Display 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.
-
Update Table Metadata
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…
-
Update Timeline by 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.
-
Update Timeline Event by 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.
-
Update User by 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…
-
Validate Password Reset Token
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.
Setup
Connect Metabase in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
