Add Media to Shopify Product

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

Annotations only declare the generic safety profile (readOnly=false, destructive=false, idempotent=false, openWorld=true). The description goes well beyond that, disclosing asynchronous fetching, the UPLOADED/PROCESSING to READY lifecycle, and the important failure mode where unreachable URLs fail silently with a FAILED status.

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?

Two tight sentences with the core action front-loaded and the operational caveat (async lifecycle and silent failure) following. No filler.

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, the description carries the return-value burden and does so by describing the status progression and the FAILED case, plus a verification path. Nothing essential is missing for correct invocation or interpretation.

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%; url and alt are documented in the schema while type has an enum but no description. The description reinforces the crucial 'publicly reachable URL' constraint, which adds real value, but it says nothing about the media array structure or the type field, so it only partially compensates.

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 (attach) and resource (images or video to a product) with the key constraint that sources are publicly reachable URLs. It is clearly distinguishable from siblings like shopify_update_product or shopify_get_product_by_id without opening either schema.

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?

Explains the context of use and explicitly routes the agent to shopify_get_product_by_id to verify a suspected silent failure. It does not state exclusions (e.g., when to prefer shopify_update_product for media edits), so it falls just short of full when/when-not guidance.

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