edit

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

Annotations only declare that this mutates and touches the open world; the description adds the critical non-obvious behavior that an ambiguous match fails unless `replace_all` is true. It doesn't say what happens on a zero-match or what the result reports, but the failure semantic is the highest-value disclosure here.

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 filler, and the core verb-plus-constraint is front-loaded. Nothing is redundant with the schema or annotations.

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 four-parameter mutation tool with no output schema, the description covers the one behavior an agent is most likely to get wrong (ambiguity). The gaps are the return value and the not-found case, which are minor for this tool class.

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 description coverage is 0%, so the schema supplies types only. The description explains `replace_all`'s effect and implies `old_string`/`new_string`/`path` semantics through 'exact text replacement after reading the file', but it leaves exact-match and zero-match behavior for the other three parameters unstated.

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 states a specific verb+resource: 'exact text replacement' in a file, which clearly separates it from a wholesale `write`. It does not, however, name siblings like `multi_edit` or `write` to disambiguate when several edit-like tools are present.

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?

'after reading the file' does encode a real prerequisite workflow, which is more than most edit tools offer. But there is no guidance on when to prefer `multi_edit` (several replacements) or `write` (full rewrite), so the agent must infer the boundaries from the sibling names alone.

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