Compare Shopify Catalogs

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

With annotations declaring readOnlyHint, idempotentHint, and destructiveHint=false, the safety profile is already covered. The description adds the specific fields being compared, which is useful context, but does not disclose any behavioral traits beyond that, such as how missing handles are handled or the format of the comparison result.

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, front-loaded sentence that efficiently communicates the tool's purpose. It lists the comparison fields without unnecessary elaboration, making it easy for an agent to parse quickly.

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 the tool's moderate complexity (two array inputs with validations) and the presence of annotations covering safety, the description is mostly complete. The only gap is the lack of clarity about the output format—a comparison tool typically returns some diff or aggregated view, but this is not described. However, for a read-only tool with well-defined inputs, this omission is minor.

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 both 'stores' and 'handles' are already well-documented with their types and constraints. The description reinforces the meaning (e.g., 'across multiple Shopify stores' and 'exact handles') but does not add extra semantic detail beyond the schema, such as what constitutes a valid handle or store alias. Baseline of 3 is appropriate.

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') and the specific fields (product titles, status, vendor, product type, and inventory) for exact handles across multiple Shopify stores. It is distinct from sibling 'shopify_compare_inventory' because it covers more than just inventory, though it does not explicitly name that alternative.

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 the usage: when you need to compare catalog fields across stores. However, it does not explicitly state when to use this tool versus the sibling 'shopify_compare_inventory' or other tools like 'shopify_portfolio_snapshot'. No exclusions or alternative routing are provided, leaving the agent to infer.

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