delimit_diff_report

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

No annotations provided. Description discloses that it runs the complete pipeline, produces self-contained HTML with inline CSS, and supports optional file output. Lacks mention of side effects or limitations, but adequate given zero 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 paragraphs, front-loaded with purpose and pipeline steps, then usage guidance. No redundant sentences.

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?

Has output schema (signal indicates). Explains output formats and pipeline. Lacks details on performance or size limits, but complet enough 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 100% with descriptions for all 5 parameters. Description adds meaning about output formats and pipeline context, but parameter semantics are already well covered by the 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 clearly states it generates a shareable API diff report with full analysis, listing pipeline components (diff, policy evaluation, semver, spec health, migration guide). It distinguishes from sibling tools like delimit_diff which likely provides a simpler diff.

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 says 'Use this when teams need a shareable artifact for API review, PR comments, or compliance records.' Provides clear context, though no explicit when-not-to-use or alternatives like delimit_diff.

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