batch_array_replace

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

No annotations are provided, so the description fully covers behavioral traits: it details skipping conditions (property missing, old_value absent, property not array) and states that files are only included in updated_files if modified. This is comprehensive.

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 well-structured with sections for intro, arguments, returns, and notes. It is concise, with no unnecessary words, while covering all essential 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 (batch file operation), the description covers all necessary aspects: purpose, parameters, return structure, and edge cases. The output schema exists and the description aligns with it. Sibling tools provide differentiation.

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 0% description coverage, but the description provides meaningful context for all parameters: glob pattern with example, property name, old_value, new_value. It adds value beyond the schema's bare type definitions.

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 it replaces a value in an array property in multiple files, with specific verb 'replace' and resource 'array property in multiple files'. It distinguishes from sibling tools like batch_array_add and batch_array_remove by focusing on replacement.

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 explains when to use the tool (replacing a value across files matching a glob) and provides notes on edge cases (e.g., skipping if property doesn't exist). It does not explicitly say when not to use or provide direct alternatives, but sibling tools are listed separately.

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