post-crm-v3-objects-line_items-batch-update_update

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

Annotations are absent, so the description must disclose behavior. It mentions updating by ID or unique property and requires a body, but it does not explain permissions, idempotency, response behavior, or error handling. This is minimal disclosure for a 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 two concise sentences plus a focused example. Every part serves a purpose, and it is front-loaded with the core update functionality.

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 schema is rich and the example clarifies the input structure, but the absence of an output schema means the return value or error behavior is unstated. This leaves gaps for an agent needing to interpret the result of the update.

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 schema has 100% coverage with descriptions for all parameters, so a baseline of 3 is appropriate. The description adds an example of the body wrapper and inputs array, but this is supplementary rather than essential 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 'Update a batch of line items by internal ID, or unique property values', specifying the verb, resource, and scope. This distinguishes it from sibling batch-create and batch-archive tools.

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?

It provides a required body parameter and an example, making the usage context obvious for batch updates. However, it does not explicitly mention alternatives or when-not-to-use scenarios, though the name and description imply the correct context.

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