Skip to main content
Glama

get_dashboard

Read-onlyIdempotent

Fetch one dashboard by ID. Includes widget definitions, the most recent refresh data, and the web URL.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dashboard_idYesUUID of the dashboard to fetch.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameYes
statusYesDashboard lifecycle status.
web_urlYes
is_publicYes
created_atNo
updated_atNo
descriptionNo
last_refreshNo
configurationNoDashboard layout and widget configuration.
analysis_metadataNoAnalysisEngine envelope captured when the dashboard was created.

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the agent knows this is a safe read operation. The description adds value beyond annotations by specifying exactly what is included in the response (widget definitions, recent refresh data, web URL), providing useful context about the tool's output.

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 a single sentence that front-loads the core purpose, followed by a concise list of included elements. Every word earns its place with no redundancy or filler.

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?

The tool has a simple parameter set and an output schema, so the description doesn't need to explain return values. It covers the key behavioral aspect (what the fetch includes) and is fully self-sufficient for a single-ID fetch operation.

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?

The schema description for dashboard_id is already 100% complete and self-explanatory ('UUID of the dashboard to fetch'). The tool description does not add parameter-specific details, but given full schema coverage, the baseline of 3 is appropriate.

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 starts with 'Fetch one dashboard by ID', clearly indicating a specific verb (fetch) and resource (dashboard by ID). It further distinguishes from sibling tools like list_dashboards by emphasizing the singular fetch and including what the result contains (widget definitions, refresh data, web URL).

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 clearly implies this tool is for retrieving a single dashboard when its ID is known, which naturally differentiates it from list_dashboards. However, it does not explicitly state when to use an alternative or provide an exclusion criterion, so it misses the top score.

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.

TDQS

A3.9/5.0
Disambiguation4/5

Tools are generally distinct by resource and action, but a few status polling tools (check_integration_status, get_analysis_status) could be confused without careful reading; descriptions clarify the difference.

Naming Consistency4/5

Most tools use a consistent verb_noun snake_case pattern, but there is minor variation (e.g., 'check' vs 'get' for status, and some compound nouns like 'request_oauth_integration_url').

Tool Count4/5

26 tools is slightly above the typical range but appropriate for a comprehensive BI platform covering data ingestion, analysis, forecasting, reports, dashboards, and account management; each tool has a clear purpose.

Completeness2/5

The tool surface is heavily read-oriented, lacking update and delete operations for most resources (data sources, dashboards, reports, forecasts). This leaves significant lifecycle management gaps for an agent.

Resources