Adjust Inventory

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

The description reveals that the operation overwrites the counted quantity, which is a concrete destructive behavior beyond the general destructiveHint annotation. It also notes that adjustmentReasonName must match a configured reason and that the operation returns the Logiwa result. These details add meaningful behavioral context not fully captured by annotations.

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 front-loaded with a clear purpose, followed by a prerequisite and a structured argument list. It is somewhat redundant with the schema but remains efficient and well-organized. No filler sentences.

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 5 parameters, a nested additional_fields object, no output schema, and destructive annotations. The description covers purpose, prerequisites, overwrite behavior, the reason constraint, and return value. The schema covers the remaining parameter details, making the overall context adequate for an agent to invoke it 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?

The input schema covers all parameters with descriptions, providing a high baseline. The description adds value by specifying the inventoryIdentifier should come from logiwa_list_inventory and that adjustmentReasonName must match a configured reason, which is not in the schema. The argument list largely repeats schema, but the extra constraints justify a slight bump.

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 the tool 'Adjusts the on-hand quantity of an inventory record to a new value' and emphasizes 'overwrites the counted quantity.' This distinguishes it from sibling tools like logiwa_add_inventory or logiwa_remove_inventory, and it specifies the record source (logiwa_list_inventory).

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 context by saying the adjustment sets a new value and overwrites the existing quantity, making it clear this is for absolute updates. It also instructs to identify the record via inventoryIdentifier from logiwa_list_inventory. However, it does not explicitly contrast with add/remove/transfer alternatives, so it's clear but lacks explicit exclusions.

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