Get Dashboard Details

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

Annotations clearly mark the tool as readOnlyHint, openWorldHint, idempotentHint, and non-destructive. The description adds additional behavioral insight: 'reveals what metrics and entities the dashboard monitors' and describes the return object. This goes beyond annotations without contradicting them.

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

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

The description is extremely concise: 5 lines including Args and Returns sections. Every sentence serves a purpose, and the main action is front-loaded. No unnecessary repetition.

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

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

For a simple read tool with one parameter and no output schema, the description adequately explains the return value (complete dashboard object with widgets, layout, and data source configuration). It also provides the ID source. While it could mention permissions or rate limits, annotations cover the safety profile.

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

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

The input schema already describes 'dashboardId' as a numeric ID. The description adds the origin hint ('from appd_get_dashboards'), which adds context beyond the schema. Given 100% schema coverage, this is a meaningful addition.

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

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

The description clearly states 'Get the full definition of a specific dashboard' with explicit verb and resource. It mentions 'including all widgets and their configurations' for specificity. However, it does not explicitly differentiate from sibling tools like appd_get_dashboards (which lists dashboards) or other get tools, though the context of retrieving a single dashboard is implied.

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

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

The description provides context: 'useful for understanding what a team cares about, or for cloning/modifying dashboards.' It also hints at the appropriate source of the ID ('from appd_get_dashboards'). However, it does not explicitly state when not to use this tool or suggest alternatives among the many sibling tools.

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