prepare_shopify_payload

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

With no annotations, the description carries the transparency burden. It discloses that the tool returns a GraphQL query and JSON payload, lists included fields, and emphasizes it is for automatic publication without copy/paste. It does not mention side effects or permissions, but for a pure data transformation this is sufficient.

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 dense sentence that front-loads the action, followed by a concise list of return contents. It contains no fluff, though it is somewhat long due to enumerating fields.

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?

Despite lacking an output schema, the description specifies exactly what is returned (query and payload with key fields) and the expected input from enrich_product. It does not discuss error cases or formatting details, but for a transform tool with moderate complexity, this is reasonably complete.

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 50%, with the 'product' parameter well-defined by the schema and 'handle' briefly described. The description adds meaning by listing output fields (title, descriptionHtml, handle, vendor, tags, metafields, image), but does not fully explain the mapping from product fields to those outputs. It partially compensates for the schema gaps.

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 uses a specific verb-converts an enriched product into a Shopify Admin GraphQL payload-and clearly identifies the resource and outcome. It distinguishes itself from sibling tools like enrich_product by focusing on the final payload preparation, not enrichment or analysis.

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?

It explicitly states the input is the output of enrich_product, which gives clear context for when to use it (after enrichment). It does not provide explicit exclusions or alternatives, but the pipeline context makes usage direction clear.

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