Set Shopify Inventory (absolute)

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

Annotations only cover the safety profile (idempotent, non-destructive, open-world). The description goes well beyond them by explaining the compare-and-set concurrency model, the role of compareQuantity, and the data-loss risk of ignoreCompareQuantity: true clobbering a concurrent update, plus an activation prerequisite.

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?

Front-loads the core semantics and the alternative tool in the first two sentences, then the concurrency caveat, then the prerequisite. Slightly long with a few adjacent restatements of compareQuantity, but every section carries operational information.

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?

With no output schema needed and 7 parameters, the description covers the mutation semantics, the safety/override switch, the sibling routing, and the activation prerequisite — everything required to invoke it correctly, including the risky path.

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 71% and the description compensates by explaining what compareQuantity means (the quantity you believe is currently there), what ignoreCompareQuantity does, and that quantity is the exact target. It does not clarify the name enum (available vs on_hand) or reason values, which the schema carries.

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?

States a specific verb and resource (set stock to an exact number) with a concrete example showing that quantity: 42 means 'there are now 42', and explicitly contrasts the absolute semantics with the relative sibling shopify_adjust_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?

Gives explicit when-to-use ('stocktakes', 'syncing from a source of truth') and when-not ('we sold 3' → use shopify_adjust_inventory), and adds a prerequisite: the variant must already be stocked at the location, activated via shopify_set_variant_locations.

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