Skip to main content
Glama
0xteamhq

Grafana MCP Server

by 0xteamhq

get_dashboard_panel_queries

Retrieve panel queries and information from a Grafana dashboard using its UID to access monitoring data and query configurations.

Instructions

Retrieve panel queries and information from a Grafana dashboard

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidYesThe UID of the dashboard

Implementation Reference

  • The handler function that executes the tool logic: fetches the dashboard by UID using GrafanaClient, extracts panels, maps them to titles, IDs, and their query targets (expr/query/rawSql, datasource, refId), and returns the structured queries.
    handler: async (params, context: ToolContext) => {
      try {
        const client = new GrafanaClient(context.config.grafanaConfig);
        const dashboard = await client.getDashboardByUid(params.uid);
        
        const panels = dashboard.panels || [];
        const queries = panels.map((panel: any) => ({
          title: panel.title,
          panelId: panel.id,
          queries: panel.targets?.map((target: any) => ({
            query: target.expr || target.query || target.rawSql || '',
            datasource: target.datasource,
            refId: target.refId,
          })) || [],
        }));
        
        return createToolResult(queries);
      } catch (error: any) {
        return createErrorResult(error.message);
      }
    },
  • Zod input schema validation for the tool, requiring a dashboard UID.
    const GetDashboardPanelQueriesSchema = z.object({
      uid: z.string().describe('The UID of the dashboard'),
    });
  • Registration function that adds the getDashboardPanelQueries tool (along with other dashboard tools) to the MCP server instance.
    export function registerDashboardTools(server: any) {
      server.registerTool(getDashboardByUid);
      server.registerTool(getDashboardSummary);
      server.registerTool(getDashboardProperty);
      server.registerTool(getDashboardPanelQueries);
      server.registerTool(updateDashboard);
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states 'Retrieve' which implies a read operation, but lacks details on permissions, rate limits, output format, or error handling. This is a significant gap for a tool with no annotation coverage.

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

Conciseness4/5

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

The description is a single, efficient sentence that directly states the tool's function without unnecessary words. It's appropriately sized and front-loaded, though it could be slightly more informative without losing conciseness.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what 'panel queries and information' includes, how results are structured, or any behavioral traits, making it inadequate for a tool that retrieves data from a dashboard.

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

Parameters3/5

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

Schema description coverage is 100%, so the input schema fully documents the single parameter 'uid'. The description doesn't add any extra meaning beyond what's in the schema, such as explaining what a 'panel query' entails or how the UID is obtained, but the baseline is 3 since the schema does the heavy lifting.

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

Purpose4/5

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

The description clearly states the action ('Retrieve') and target resource ('panel queries and information from a Grafana dashboard'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'get_dashboard_by_uid' or 'get_dashboard_summary', which might retrieve related dashboard data, so it misses full sibling distinction.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. The description doesn't mention prerequisites, context, or exclusions, such as how it differs from other dashboard-related tools in the sibling list, leaving usage unclear.

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/0xteamhq/mcp-grafana'

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