Bulk Update Actual Production Quantities

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

Annotations indicate readOnlyHint=false, destructiveHint=false. The description adds that it returns the modified object on success and mentions partial updates ('only the supplied fields are changed'). This provides some behavioral context beyond annotations, but it does not disclose error handling or rate limits.

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 four sentences, providing essential information without excessive verbosity. It includes endpoint details and API context, which may be considered slightly extraneous, but overall it is well-structured.

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 tool has no output schema, and the description only says 'returns the modified object on success' without specifying the response structure for bulk operations. The actual_production_quantities parameter is underspecified, leaving ambiguity about the required format. More detail is needed for an AI agent to invoke the tool correctly.

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%, but the schema for actual_production_quantities is an array with empty items type ({}), offering no structure. The description only lists required parameters without explaining the array's item format or what fields can be updated. No additional meaning is added beyond the parameter names.

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 bulk updates Actual Production Quantities (APQ) and mentions it updates existing Field Productivity records. The purpose is discernible, but it does not explicitly differentiate from the singular update_actual_production_quantity tool or from sibling bulk 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?

The description says 'Use this to update an existing Field Productivity records (only the supplied fields are changed),' which implies usage for partial updates. However, it provides no guidance on when to avoid this tool or mention alternatives like bulk_create or bulk_destroy.

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