update_inventory

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

No annotations provided, so description carries full burden. Describes batch acceptance and auth requirement, but fails to disclose idempotency, error handling, or behavior when cardId doesn't exist. The schema's quantity=0 deletion conflicts with the description's suggestion to use remove_inventory, creating confusion.

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?

Short and front-loaded with key points: purpose, batch, alternative, auth. Could be slightly tighter, but each sentence serves a purpose.

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?

No output schema and no description of return value. Missing batch size limits, rate limits, and behavior on partial success/failure. Auth requirement is mentioned, but overall incomplete for a mutation tool.

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 0% (per context), and the description does not explain the items parameter or its subfields beyond 'accepts a batch'. The schema itself contains descriptions, but they are not credited to the description. Thus, the description adds minimal value for parameter understanding.

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?

Clearly states it updates quantities for existing inventory rows, distinguishing it from remove_inventory. However, it doesn't clarify the update semantics (e.g., additive or absolute) and the overlap with quantity=0 deletion.

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?

Explicitly names remove_inventory as an alternative for deletion and notes the required IWMM_API_KEY. Lacks comparison with add_inventory for new rows, but implies usage for existing rows only.

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