generate_report

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

Adds value beyond annotations by stating 'Opens in browser by default' and mentioning optional source blocks. Annotations already cover readOnlyHint=false, destructiveHint=false, so no contradictions.

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 with no waste. The cross-reference is efficient and well-placed. Front-loaded with key purpose.

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 the main purpose, output characteristics (HTML, browser, TOC, source blocks), and cross-reference. Lacks explicit return value info, but output schema absent. Adequate for the tool's complexity.

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 baseline is 3. The description includes a brief example for the dgmo parameter but does not add substantial new meaning beyond the schema's descriptions.

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 states the verb 'Generate' and resource 'polished HTML report with multiple DGMO diagrams, table of contents, and optional source blocks', clearly distinguishing from sibling tools like preview_diagram or render_diagram which handle single diagrams.

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 cross-reference to get_language_reference for DGMO syntax, guiding when to use that sibling tool. However, it does not specify when to avoid this tool or contrast with alternatives like share_diagram.

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