Skip to main content
Glama

get_dashboard

Read-only

Fetch a single analytics dashboard (board) by id: its saved queries (type, chart style, events) and every panel on its 24-column grid (query, markdown and image panels, each with id and x/y/w/h). Use after list_dashboards to get the complete detail for a specific board, and before changing its layout.

Input Schema

NameRequiredDescriptionDefault
projectIdYesThe project (application) id to scope this call to. Use list_projects to discover valid ids.
dashboardIdYesThe id of the dashboard to fetch.
environmentYesThe environment name to scope this call to (e.g. 'production'). Use list_projects to discover the names available to this token.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered structurally; the description adds useful context by disclosing exactly what the response contains (query, markdown, and image panel types with geometry). It says nothing about behavior when the dashboard id does not exist or about permission scoping, which would have completed the picture.

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?

Two sentences, front-loaded with the action and payload, then the usage rule. The parenthetical list of panel fields is dense but each item earns its place by telling the agent what it can read from the result; minor trimming of "(board)" would tighten it further.

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?

With no output schema, the description carries the burden of describing the return value and does so concretely, including panel types and grid coordinates, which is exactly what an agent needs before calling update_dashboard_layout. Nothing essential for a read-only, three-required-parameter fetch is missing.

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%, with projectId, dashboardId, and environment each documented including discovery via list_projects. The description only restates that lookup is "by id" and adds no scoping or format detail beyond the schema, so the baseline 3 applies.

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 uses a specific verb+resource ("Fetch a single analytics dashboard (board) by id") and immediately enumerates the payload: saved queries with type/chart style/events and every panel on a 24-column grid with id and x/y/w/h. This clearly distinguishes it from list_dashboards and from the panel-mutation siblings like add_markdown_panel.

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?

It explicitly says to use it after list_dashboards for full detail on a specific board and before changing its layout, which gives the agent a clear position in the workflow. It does not state any when-not conditions or mention that update_dashboard_layout is the follow-up mutation tool by name, so it falls short of full routing guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources