Skip to main content
Glama
voducdan

metabase-mcp

by voducdan

list_dashboards

Retrieve a list of all Metabase dashboards with their IDs, names, descriptions, collection IDs, and creator details.

Instructions

List all dashboards in Metabase.

Returns: A list of dashboards with their metadata including id, name, description, collection_id, and creator info.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The actual MCP tool handler function for 'list_dashboards'. It is decorated with @mcp.tool (line 884), which also serves as its registration. The function makes a GET request to Metabase's /api/dashboard endpoint, logs the results, and returns the list of dashboards.
    # =============================================================================
    # Tool Definitions - Dashboard Operations
    # =============================================================================
    
    @mcp.tool
    async def list_dashboards(ctx: Context) -> list[dict[str, Any]]:
        """
        List all dashboards in Metabase.
    
        Returns:
            A list of dashboards with their metadata including id, name,
            description, collection_id, and creator info.
        """
        try:
            await ctx.info("Fetching list of dashboards from Metabase")
            result = await metabase_client.request("GET", "/dashboard")
            dashboard_count = len(result) if isinstance(result, list) else len(result.get("data", []))
            await ctx.info(f"Successfully retrieved {dashboard_count} dashboards")
            return result
        except Exception as e:
            error_msg = f"Error listing dashboards: {e}"
            await ctx.error(error_msg)
            raise ToolError(error_msg) from e
  • server.py:884-884 (registration)
    The @mcp.tool decorator on line 884 registers 'list_dashboards' as a FastMCP tool. The function name (list_dashboards) becomes the tool name exposed via MCP.
    @mcp.tool
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It does not disclose behavioral traits beyond listing, such as permissions, pagination, or side effects. The read-only nature is implied but not explicit.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with two sentences: one for action and one for return value. Every word is purposeful with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple list tool with no parameters and an output schema (implied), the description sufficiently covers the purpose and return format. No additional context is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are zero parameters, so the baseline is 4. The description adds nothing about parameters, but that is acceptable as none exist. It briefly describes the output, which aligns with the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'List all dashboards in Metabase', providing a specific verb and resource. It effectively distinguishes from sibling tools like create_dashboard or update_dashboard.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for obtaining a list of all dashboards without explicit exclusions or alternatives. While clear, it does not explicitly guide when not to use it versus other list tools like list_cards.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/voducdan/matebase-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server