delimit_diff_report

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

Discloses that the tool is read-only on inputs and only writes to disk when output_file is provided, plus details about HTML output. With no annotations, this covers key behavioral traits well, though rate limits or auth requirements not mentioned.

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?

Very concise and well-structured with clear sections (purpose, when to use/not, sibling contrast, side effects). 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?

Given the presence of an output schema, the description covers all necessary context: usage, side effects, input spec types, and report contents. Complete for agent decision-making.

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%, so the schema already documents all parameters. The description adds minimal extra semantics beyond the schema, but the side effects note provides useful context for output_file. Adequate for baseline.

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 it generates a shareable API diff report with full analysis, and explicitly distinguishes from siblings delimit_lint and delimit_diff, which serve different purposes.

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 'When to use' and 'When NOT to use' guidance, including specific alternative tools (delimit_lint for CI gate, delimit_diff for raw data), making it easy for the agent to select correctly.

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