shopify_attach_product_media

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

The annotations already flag this as non-read-only, idempotent, and destructive. The description adds genuinely useful behavioral context beyond that: the 50-item batch limit and the asynchronous processing behavior, warning that images may report UPLOADED before rendering on the storefront. There is no contradiction with the 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 the key operational facts, followed by a compact Args block where every parameter gets a meaningful one-line explanation. There is no filler; every sentence contributes to the agent's ability to call the tool correctly.

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 description is largely complete for a write tool of this complexity: it covers required inputs, payload structure, batch limits, and the important asynchronous consequence. An output schema exists, so return-value details are not needed. The main minor gaps are the lack of authentication/prerequisite context and the small mismatch between the declared required parameters and the schema's optional fields.

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?

With 0% schema description coverage, the description carries the full burden and mostly succeeds: it marks product_id and media as required, gives accepted forms (numeric or GID; JSON-string list), and details the media object fields (original_source, media_content_type?, alt?). It also explains each correlation/idempotency/approval parameter. However, it slightly conflicts with the schema, which lists all parameters as optional and types media as an array of strings rather than a JSON-string.

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 first sentence states the verb-resource pair clearly: 'Attach media (product shots) to an existing product' and identifies acceptable sources (public URLs or staged resource urls). The 50-entry cap adds specificity. It is unambiguous in intent, though it does not explicitly distinguish this tool from sibling tools like shopify_create_file or shopify_stage_upload.

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 usage context is implied: use this when an existing product needs media attached from URLs. However, the description provides no explicit when-to-use or when-not-to-use guidance, and it does not name alternatives or conditions for choosing a different Shopify tool.

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