previewEdit

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

The description discloses that the tool produces a unified diff (behavior) and does not write to disk (safety). This aligns with and adds value beyond the readOnlyHint annotation, explaining the exact output format and confirming no side effects.

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?

The description is a single, well-structured sentence that front-loads the core purpose. Every word is informative; no redundancy or 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?

Despite lacking an output schema, the description clearly states the output format (unified diff), which is sufficient for an agent to understand the return value. All required parameters are covered by the schema, and the description adds essential context about the operation types.

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 100%, so the baseline is 3. The description does not add significant meaning beyond the schema, as it simply groups parameters under 'editText or searchAndReplace' without elaborating on individual fields.

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 the tool's purpose: to preview what editText or searchAndReplace would do as a unified diff without writing to disk. This clearly identifies the verb (preview), resource (editText/searchAndReplace operations), and differentiates from the tools that actually perform the edits.

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 implies usage before applying editText or searchAndReplace to see the diff. However, it does not explicitly mention when not to use or compare with other preview-like siblings such as previewCodeAction. The context is clear but lacks explicit guidance on alternatives.

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