update_dashboard

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

No annotations are provided, so the description carries the full burden. It states that the tool updates a dashboard, which implies mutation. It does not disclose potential side effects, required permissions, or whether the operation is reversible. The return type is mentioned but not in detail. Adequate but not thorough.

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 concise with a front-loaded purpose statement, followed by a structured Args list and Returns line. Every sentence adds value, and the format is clean without unnecessary words.

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?

With an output schema present, the description does not need to detail return values, but it still provides a brief note. The 5 parameters are all explained. However, it could mention that the dashboard must already exist (it is an update, not create). Overall, very good but slightly incomplete regarding prerequisites.

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?

Schema description coverage is 0%, but the description explicitly explains each parameter in the Args section (dashboard_id, name, description, collection_id, parameters). This fully compensates for the lack of schema descriptions, adding meaning beyond the raw schema.

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 starts with 'Update an existing dashboard in Metabase,' which clearly states the verb (update) and resource (dashboard). This distinguishes it from sibling tools like create_dashboard, delete_dashboard, get_dashboard, and list_dashboards.

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention prerequisites (e.g., the dashboard must exist), restrictions, or when not to use it. The purpose is implied but lacks explicit usage context.

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