batch_update_documents

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

Annotations indicate mutating, destructive, and idempotent behavior. The description adds that processing is sequential, continues on individual failures, and handles rate limiting. This gives the agent a clear behavioral model beyond the annotations.

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 a headline, bullet points for usage, a note, batch size recommendation, and parameter listing. Every sentence adds value without redundancy.

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 operation with partial failures), the description covers failure handling, rate limiting, batch size, parameter semantics, and usage patterns. The presence of an output schema means return values don't need further explanation.

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% parameter description coverage, but the description details each field in the update dictionary (id, title, text, append) with required/optional flags and meaning. This fully compensates for the schema's lack of descriptions.

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 'Updates multiple documents with different changes,' which is a specific action on a specific resource. It distinguishes from sibling tools like update_document (single) and batch_archive_documents (different operation).

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?

Explicit usage scenarios are listed ('Use this tool when you need to...') with bullet points covering common cases. It also provides a recommended batch size. Missing explicit alternatives like 'use update_document for single updates,' but still strong guidance.

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