apply_edit_plan

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

Annotations lack detail (destructiveHint false, but description says 'revalidating every target', hinting at mutation). Description adds that it revalidates, a key behavioral trait, but does not disclose failure behavior or side effects.

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 purpose, second sentence with constraints. No unnecessary words.

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?

No output schema, so description should provide more about return values or error cases. Lacks failure behavior details (e.g., what if revalidation fails). Plan object constraints are partially described.

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 clear descriptions for both parameters. Description adds no additional meaning beyond mentioning the required edit capability, which is not a parameter.

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 clearly states the verb 'apply' and resource 'previewed compound edit'. Distinguishes from sibling 'preview_edit_plan' by indicating it is the execution step after preview.

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?

Specifies prerequisites: edit capability and exact confirmation token. Implicitly requires prior call to preview_edit_plan. Could explicitly state not to use without a fresh preview token.

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