Skip to main content
Glama

get_dashboard

Read-onlyIdempotent

Fetch one org-shared dashboard's full layout — its placed widgets, custom metrics and custom charts, and their grid positions. A widgets entry references a preset catalog_id (see list_dashboard_widget_catalog); customMetrics/customCharts carry their own full config inline. Call this before set_dashboard_widgets if you want to keep some of what's already there rather than replacing the whole set — that tool always replaces everything.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dashboard_idYesA shared dashboard id from list_dashboards

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive, so the safety profile is covered. The description adds genuinely useful behavioral context beyond annotations: that widgets reference a preset catalog_id while custom metrics/charts carry inline config, and the replacement semantics of the downstream set_dashboard_widgets. It does not cover output shape, but no output schema exists so this is a modest gap.

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?

Three sentences, front-loaded with what is fetched, then content structure, then the when-to-use rule. Every sentence earns its place with no filler.

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

Completeness4/5

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

For a single-param read tool with full annotation coverage and no output schema, the description supplies the key context: what the layout contains, how references are shaped, and the ordering constraint relative to set_dashboard_widgets. It is complete enough for correct invocation; the only minor gap is return-shape detail, which is acceptable without an output schema.

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?

Schema coverage is 100% and the dashboard_id parameter is already documented as 'a shared dashboard id from list_dashboards'. The description reinforces the scoping ('one org-shared dashboard') which clarifies that list_dashboards is the source of valid ids, but adds no syntax the schema lacks. A 4 reflects the marginal reinforcement without introducing new parameter detail.

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?

States a specific verb and resource ('Fetch one org-shared dashboard's full layout') and enumerates what the layout contains — placed widgets, custom metrics, custom charts, grid positions. This clearly distinguishes it from list_dashboards (enumeration) and from list_dashboard_widget_catalog (the preset catalog).

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

Usage Guidelines5/5

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

Gives explicit when-to-use guidance: call before set_dashboard_widgets if you want to preserve existing widgets, because that tool always replaces the whole set. It also points to list_dashboard_widget_catalog for resolving catalog_id references, routing the agent to the right sibling.

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