edit_block

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

With no annotations available, the description is solely responsible for disclosing behavior. It only states 'Edit block', offering no information on side effects, permissions, or how the editing works (e.g., find-and-replace, in-place modification). This is insufficient for an agent to understand the tool's impact.

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?

While extremely short, the description is under-specified rather than concise. It sacrifices essential information for brevity, lacking structure or front-loading of critical details.

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 tool's complexity (5 parameters, no output schema, no annotations), the description is vastly incomplete. It does not explain return values, error handling, or how the block editing process works, leaving significant gaps for an AI agent.

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?

The input schema has 5 parameters with 0% description coverage. The tool description provides no additional context for parameters like file_path, old_string, or new_string, failing to clarify their roles or acceptable values. This leaves the agent without essential guidance.

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 'Edit block' is a tautology of the tool name and provides no additional meaning. It fails to specify what a 'block' is in this context, nor does it differentiate from sibling tools like write_file or execute_command.

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 usage guidance is provided. The description does not indicate when to use this tool versus alternatives such as write_file or search_files, nor does it mention prerequisites or limitations.

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