Edit File

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

Annotations already show destructiveHint=true and readOnlyHint=false. The description adds that edits replace exact line sequences and returns a diff. However, it does not disclose behavior when oldText is not found or multiple matches occur, which is needed given the destructive nature.

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?

Three sentences, front-loaded with the main action. No wasted words, though could include the dryRun preview mention more prominently. Efficient for the information provided.

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 the destructive nature and the availability of an output schema (not shown but noted), the description covers the main behavior and return (git-style diff). However, it lacks guidance on dryRun usage, error cases, or safety, leaving some gaps for a tool that modifies files.

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 33%; only dryRun has a description. The description adds that each edit replaces exact line sequences and that oldText must match exactly, providing some meaning beyond the schema for the edits parameter, but does not fully compensate for missing parameter descriptions, especially path.

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 uses specific verbs and resources ('Make line-based edits to a text file'), clearly distinguishes from siblings like write_file by focusing on line-based edits and returning a diff. It is unambiguous and actionable.

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 states a constraint ('Only works within allowed directories') but does not explicitly guide when to use this tool vs alternatives like write_file or search_files. Usage context is implied but not elaborated.

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