delimit_explain

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

Describes side effects as 'read-only' and mentions the backend call backends.gateway_core.run_explain. No annotations exist, so the description adequately covers behavioral traits. Could add more about idempotency or rate limits, but current detail is sufficient.

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 concise with three clear sections: purpose, when/when-not to use, and side effects. Every sentence earns its place without redundancy.

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 output schema exists, the tool definition is complete. All parameters have descriptions, usage guidance is explicit, and side effects are disclosed. No gaps.

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?

All 6 parameters are described in the input schema (100% coverage). The description adds value by explaining template options and the purpose of old_version/new_version/api_name as context fields, going beyond schema labels.

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 'Render a human-readable explanation of API changes' with specific use cases like migration notes and PR comments. It distinguishes from siblings by contrasting with delimit_diff and delimit_diff_report.

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 states when to use (produce explanations) and when NOT to use (raw change data or HTML report), with sibling tool names given as alternatives. This provides clear guidance for selection.

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