Update an existing dashboard

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

With no annotations, description takes full burden. Discloses trinary semantics for nullable fields and template restriction. Does not mention authentication, rate limits, or response/error behavior, but core mutation behavior is clear.

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?

Two sentences, front-loaded with purpose, no unnecessary words. Every sentence adds essential information: what fields, how nullable fields work, and a usage restriction.

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?

Covers update fields, nullable handling, and template exclusion. Missing response description, but no output schema exists. Could benefit from mentioning that layout is a freeform object, but overall sufficient for typical use.

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 coverage is 0%, but description adds meaning for three of four parameters: name, description, layout are explicitly listed as updatable. Explains trinary semantics for nullable description. Id is not elaborated but typically understood as identifier.

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 the verb 'Update' and the resource 'an existing dashboard', listing specific fields (name, description, layout) that can be modified. It distinguishes this tool from sibling tools like dashboard_create, dashboard_delete, and dashboard_get by focusing on modification.

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?

Provides explicit condition for when NOT to use: templates (is_template = true) are read-only and cannot be edited via this tool. Also explains trinary semantics for nullable fields, guiding parameter usage (omit, null, value).

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