apply_surgical_patch

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

Description discloses the destructive nature ('Replace... entirely new code') and side effects ('Re-indexing is automatic'). Without annotations, this is adequate behavioral transparency, though could be enriched with auth requirements.

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, no redundant information. Every word is necessary, front-loading the core purpose.

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?

For a 2-param tool with output schema, the description is minimal. It covers the core operation but lacks validation hints or expected behavior for invalid input. Contextual completeness is adequate but not robust.

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?

Description implies symbol_id identifies the symbol and new_code is the replacement, adding basic meaning beyond schema with 0% coverage. However, no format or constraints are provided, leaving gaps for an AI agent.

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 action ('Replace') and resource ('existing symbol') with specific verb+resource. It distinguishes from siblings like 'surgical_read' and 'rebuild_index' by emphasizing replacement and automatic re-indexing.

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?

No explicit guidance on when to use versus alternatives. Context from sibling tool names suggests different operations, but the description does not differentiate use cases or provide exclusions.

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