Skip to main content
Glama

Push Image to Shopify

sirv_push_image_to_shopify

Publishes a Studio image asset to an imported Shopify product in the live store, optionally setting it as the featured image.

Instructions

Publish one library asset as an image of one Shopify product. The product must be imported from Shopify.

Use it to send a finished image to the store. To link an image to a product in Studio only, use sirv_link_assets_to_product.

This writes to the live store. Studio creates an approved publish plan and runs it in the background, so the image reaches Shopify a few seconds after this call returns. It only adds the image: replacing the store's images is done in Studio. Send the same idempotencyKey on a retry, so that the image is not published twice.

If Shopify changed the product since Studio last imported it, the publish fails with 409 "Shopify changed this product since it was imported". Run sirv_sync_shopify_products, then try again.

Returns the publish plan id, the run id and the run status.

Credits: free.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "productId": "<productId>",
      "assetId": "<assetId>"
    },
    "name": "sirv_push_image_to_shopify"
  }
}

Input Schema

NameRequiredDescriptionDefault
orgIdNoWorkspace id from sirv_list_organizations. Default: the workspace you signed in to
assetIdYesStudio asset id of the image to publish, from sirv_list_assets
alt_textNoAlt text for the image in Shopify, up to 512 characters
productIdYesStudio product id of a product imported from Shopify, from sirv_list_products
idempotencyKeyNoAny UUID. Send the same one when you retry this publish, so Studio does not publish it twice
set_as_featuredNotrue makes this image the product's featured image. Default: false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.1.1
    • changedInput schema / properties / alt_text / description
      Previous value: -"Alt text for the image"New value: +"Alt text for the image in Shopify, up to 512 characters"
    • changedInput schema / properties / assetId / description
      Previous value: -"Studio asset ID of the image to publish (from sirv_list_assets or sirv_search_assets)"New value: +"Studio asset id of the image to publish, from sirv_list_assets"
    • addedInput schema / properties / assetId / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • addedInput schema / properties / idempotencyKey / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • changedInput schema / properties / orgId / description
      Previous value: -"Organization ID (uses default org if omitted)"New value: +"Workspace id from sirv_list_organizations. Default: the workspace you signed in to"
    • addedInput schema / properties / orgId / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • changedInput schema / properties / productId / description
      Previous value: -"Studio product ID of a product imported from Shopify (from sirv_list_products)"New value: +"Studio product id of a product imported from Shopify, from sirv_list_products"
    • addedInput schema / properties / productId / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • changedInput schema / properties / set_as_featured / description
      Previous value: -"Set this image as the featured/main image"New value: +"true makes this image the product's featured image. Default: false"
  2. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the annotations, it discloses that this writes to the live store, runs asynchronously in the background via an approved publish plan, and may complete a few seconds after the call returns. It also covers idempotency retries, the 409 conflict condition and remedy, and the returned publish plan id, run id, and status.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with purpose and differentiation, then moves logically through write behavior, async timing, conflict handling, return values, and credits. Despite covering a complex operation, each paragraph earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex asynchronous mutation with no output schema, the description supplies the necessary prerequisites, live-store implications, retry semantics, failure handling, return values, and billing context. An agent has enough information to invoke it correctly without opening the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so parameter documentation is already strong. The description adds meaningful state semantics: productId must refer to a product imported from Shopify, and if the product changed since import, the publish fails with a specific 409 and requires sirv_sync_shopify_products before retrying.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: publishing one library asset as an image of one Shopify product. It immediately distinguishes this from the Studio-only alternative by naming sirv_link_assets_to_product.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly says when to use this tool ('send a finished image to the store') and when to use a sibling instead ('To link an image to a product in Studio only, use sirv_link_assets_to_product'). It also clarifies that replacing store images is out of scope and must be done in Studio.

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