Compare Shopify Inventory

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

Annotations already provide readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds the detail that it compares 'selected SKUs' and covers multiple stores, which aligns with the read-only comparison nature. It does not describe pagination, rate limits, or the exact output format, but the read-only nature is well covered by annotations. There is no contradiction.

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 a single clear sentence that front-loads the action and resource, then specifies the parameters (SKUs, stores) and the fields compared. Every phrase adds value—no filler or repetition. It is appropriately concise for the complexity.

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?

For a read-only comparison tool with 100% schema coverage and strong annotations (readOnly, idempotent, non-destructive), the description covers the key inputs (SKUs, stores) and the comparison dimensions (inventory, price, status, catalog). It doesn't describe the output format, but since there is no output schema and the tool is read-only, the missing return description is a minor gap. It is nearly complete for correct invocation.

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 100%, so the schema already fully documents both parameters (stores and skus) with their constraints and formats. The description repeats the scope ('selected SKUs', 'across multiple Shopify stores') but does not add new semantic meaning beyond the schema. The baseline of 3 is appropriate because the schema carries the heavy lifting.

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 action ('Compare'), the resource ('inventory, price, product status, and catalog details'), and the scope ('for selected SKUs across multiple Shopify stores'). It is distinct from sibling tools like list_stores, get_shop_info, and graphql_query variants, making the tool's purpose immediately recognizable.

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 usage when a cross-store comparison of inventory/price/status/catalog details is needed, but does not explicitly state when NOT to use it or mention alternatives like shopify_compare_catalog. It provides no exclusions or selection guidance relative to siblings, so the agent must infer the right context from the verb and target.

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