regexreplace

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

No annotations exist, so description must fully disclose behavior. It mentions encoding-awareness, binary skipping, and dry-run, but omits whether changes are irreversible, if backups are created, or error handling. For a mutation tool, this is insufficient.

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?

Five concise sentences, front-loaded with the core purpose. Each sentence adds unique value (encoding, modes, capture groups, binary skip, dry run). No superfluous wording.

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 key behaviors but lacks important details for safe use: output feedback, error handling, default values for boolean parameters (though schema includes some defaults), and whether modifications are reversible. Adequate but incomplete for a destructive tool.

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 100% with descriptions for all 8 parameters. The description adds context (encoding, binary skip, dry_run preview) but repeats schema info (e.g., capture groups). It provides marginal added value beyond the 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?

The description clearly states 'Performs regex find-and-replace across files' with specific capabilities (encoding-aware, recursive glob, capture groups, binary skip, dry run). This distinguishes it from siblings like grep or rename.

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 implicitly suggests usage for regex replacement and mentions dry_run for previews, but lacks explicit when-not-to-use or alternatives (e.g., simple text replace vs regex). No sibling differentiation is provided.

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