Update inventory

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

No annotations are present, so the description carries full burden. It discloses that 400 errors return the Loyverse error message verbatim and advises to adjust fields. However, it does not mention permissions, idempotency, or other side effects of mutation.

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 three sentences, front-loading the purpose and endpoint, then explaining the body format and error handling. No unnecessary words, though the error handling sentence could be more concise.

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 there is no output schema, the description does not describe the response format or confirm successful updates. It covers the input structure and error handling but lacks completeness for a mutation tool with nested parameters.

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% with a basic description for the body parameter. The tool description adds an explicit example structure ('{ inventory_levels: [{ variant_id, store_id, stock_after }] }'), providing extra meaning 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 inventory stock levels (POST /inventory)', establishing a specific verb and resource. It distinguishes the tool from siblings like loyverse_list_inventory by focusing on the update 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?

The description implies that listing should precede updating ('List returns stock levels per variant/store'), but does not explicitly state when to use this tool over create/delete alternatives. Error handling guidance is provided for 400 responses but no usage exclusions.

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