Skip to main content
Glama

Get dashboard

get_dashboard
Read-onlyIdempotent

A dashboard's widgets with their settings (table and field names) and each widget's current numbers over all time. Widgets with a problem (deleted field, unfinished) say so and carry no data.

Input Schema

NameRequiredDescriptionDefault
baseIdYes
dashboardYesDashboard name or id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already establish that this is a read-only, idempotent, non-destructive operation. The description adds useful behavioral detail beyond annotations: it explains what is returned (widget settings and current numbers over all time) and how problem widgets behave (they report the issue and carry no data).

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 two tight sentences with no wasted words. The key return behavior is front-loaded, and the problem-widget behavior is added efficiently.

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

Completeness3/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 does a reasonable job explaining the return shape and error behavior for problematic widgets. However, it leaves gaps around parameter meaning (especially baseId) and does not clarify lookup failure behavior or the relationship between baseId and dashboard.

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

Parameters2/5

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

The description does not mention either parameter. Schema coverage is only 50%: the 'dashboard' parameter is described as 'Dashboard name or id', but 'baseId' has no schema description and is not clarified by the tool description. The description therefore does not compensate for the incomplete parameter documentation.

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 communicates that this tool returns a dashboard's widgets, their settings (table and field names), and current values, which implies a single-dashboard retrieval operation. It is distinguishable from list_dashboards and update_dashboard by its focus on widget contents, though it never explicitly states 'retrieves one dashboard' or differentiates itself from siblings.

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?

There is no explicit guidance on when to use this tool versus alternatives such as list_dashboards, describe_base, or update_dashboard. Usage is only implied by the content description, and no exclusions or prerequisites are given.

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.