Edit File

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

Annotations already signal destructive and non-readonly behavior. The description adds context: returns a git-style diff, uses exact line sequences, and restricts to allowed directories. No contradiction with annotations.

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 that front-load purpose and efficiently cover behavior, return value, and constraint. No fluff.

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?

Covers purpose, return type, directory constraint. Missing preconditions like file existence, edit order, or safety mechanisms. With annotations and output schema present, completeness is adequate but not exhaustive.

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 low (33%), but description adds some meaning: 'line-based edits' and 'exact line sequences' clarify the edit mechanics. However, path parameter lacks format details, and edits' old/new text descriptions are already in schema.

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?

Clearly states the tool performs line-based edits on text files, replacing exact sequences. Distinguishes from siblings like write_file by focusing on targeted edits rather than full file creation/overwrite. Also mentions directory restriction.

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?

Implied usage for small targeted changes, but lacks explicit when-not-to-use or alternatives. The description does not explicitly contrast with write_file or other file manipulation tools.

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