write_full_buf

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

Without annotations, the description fully explains in-memory editing, undoability, no disk write until user saves, and buffer creation. It also specifies the return value. Minor gap: no mention of potential errors or edge cases.

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?

Seven sentences, no fluff, front-loaded with the core purpose, followed by relevant details. Each sentence adds unique value.

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 no output schema, it adequately describes the return value {total_lines}. It references sibling tool for alternative. Minor gap: no mention of error behavior or performance implications.

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 has 0% description coverage, but the description adds meaning for both parameters: file is 'path relative to Neovim's cwd' and content is 'full new text'. Could further specify content format (e.g., trailing newline).

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 explicitly states 'Replace the entire content of a Neovim buffer' and contrasts with the sibling tool find_and_replace_buf, clearly distinguishing its use case.

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?

It provides explicit when-to-use ('when you need to rewrite the whole file') and when-to-avoid ('use find_and_replace_buf instead for targeted edits'), plus clarifies file path semantics.

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