post-crm-v3-objects-invoices-batch-update_update

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

No annotations are provided, so the description carries the full burden. It discloses that the tool updates invoices and requires a body parameter, but does not mention batch behavior (e.g., atomic vs partial success), error handling, response format, or prerequisites. This is insufficient for a batch mutation tool.

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 clear sentence followed by a practical example. It is front-loaded with the action and resource, and contains no fluff or redundant information.

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?

The description provides a clear purpose and example, and the schema covers all parameters. However, with no output schema and no annotations, it lacks details on return values, error handling, or batch update semantics. It is minimally adequate for basic invocation but not comprehensive.

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%, providing baseline 3. The description adds a concrete example showing the structure of the inputs array and how to update a property, which helps the agent construct the call correctly. This example clarifies the nested object format beyond the schema listings.

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 'Update a batch of invoices by internal ID, or unique property values,' which identifies the specific verb (Update), resource (batch of invoices), and method of targeting. This distinguishes it from sibling tools that create, archive, or upsert invoices.

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 gives clear context: use this tool to update multiple invoices in a batch. It also specifies the required body parameter with an example. However, it does not explicitly mention when not to use it or alternatives like single-update endpoints.

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