Replace In File (Gated)

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

Annotations indicate destruction; the description adds critical safety context: dry-run unless confirm=true, backup, audit, and occurrence verification, which fully informs the agent of the tool's guarded behavior.

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 contain all essential information with no redundancy; front-loaded with action and gating.

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 8 parameters and destructive nature, the description covers purpose, gating, and safety, though it could explicitly link 'occurrence verification' to expectedOccurrences parameter.

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 50%; the description does not detail individual parameters but adds meaning by explaining the interaction between dryRun and confirm gates, and mentions occurrence verification, exceeding 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?

The description clearly states the tool performs exact-string replacement with occurrence verification, and distinguishes it from siblings like sdlc_write_file by emphasizing the gated dry-run behavior and backup/audit on apply.

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?

The description implies when to use (when exact-string replacement with safety and verification is needed) and explains dry-run/confirm gating, but does not explicitly list when not to use or compare with alternatives.

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