generate_report

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

Discloses that the report opens in the browser by default, which aligns with the openWorldHint annotation. Adds context about table of contents and source blocks beyond what annotations provide. No contradictions with annotations.

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 the main functionality and key differentiators. Every sentence adds value, with no redundant information.

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 main output (HTML report with TOC, source blocks), default behavior (open in browser), and links to syntax reference. Given no output schema and full annotations, it is mostly complete, though it could mention potential limitations like report size.

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 the baseline is 3. The description adds minimal additional parameter-level meaning beyond the schema, only providing an example of DGMO syntax for coloring, but not enriching individual parameter understanding.

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?

Clearly states the tool generates a polished HTML report with multiple DGMO diagrams, table of contents, and optional source blocks. It differentiates from sibling tools like render_diagram and preview_diagram by specifying 'multiple diagrams' and the report format.

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?

Explicitly guides the agent to use get_language_reference for DGMO syntax details. While it does not list when not to use the tool, it clearly implies the scope: generating reports with multiple diagrams, distinguishing it from single-diagram tools.

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