create_dashboard_doc

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

Annotations already disclose write behavior (readOnlyHint=false) and non-destructive nature (destructiveHint=false). The description adds context about the output style (AFFiNE tokens, design system) but doesn't discuss side effects, permissions, or idempotency beyond what annotations imply.

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 a single, front-loaded sentence with no filler or redundant content, making it highly concise and immediately readable.

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 create tool with annotations and an output schema, the description provides sufficient context about the tool's purpose and output. It lacks explicit usage guidance against sibling tools, but the tool is simple and the schema fills in details.

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 100%, so all parameters are documented with clear descriptions. The tool description itself adds no parameter-specific meaning beyond what the schema already provides, matching the baseline of 3.

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?

Description specifically states 'Create an AFFiNE document containing a rich interactive HTML/CSS dashboard widget' – a clear verb+resource+content type. It distinguishes from generic create_doc and similar specialized tools like create_mindmap_canvas.

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 on when to use this tool versus alternatives. The description only states what it does, not when to prefer it over create_doc or other creation tools.

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