Skip to main content
Glama

shopify_update_collection

Destructive

Update a Shopify collection's fields, rules, image, sort order, or add products to a manual collection; preview changes with a dry run before applying.

Instructions

Update collection fields, rules or image, and add products to a manual collection (addProductIds). dryRun:true (the default) returns the current collection and the change without applying it; dryRun:false applies it and returns before and after.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
imageNo
storeYes
titleNo
dryRunNoTrue (the default) returns a before/after preview without changing anything in Shopify. Pass false, after the user authorizes this store and exact change, to apply it; the tool then reads the result back.
ruleSetNo
sortOrderNo
addProductIdsNoProducts to add to a manual collection. Smart collection membership follows its rules.
descriptionHtmlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.0.1
    • addedInput schema / properties / addProductIds
      Added value: +{
      +  "description": "Products to add to a manual collection. Smart collection membership follows its rules.",
      +  "items": {
      +    "pattern": "^gid:\\/\\/shopify\\/Product\\/[0-9]+$",
      +    "type": "string"
      +  },
      +  "maxItems": 250,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • removedInput schema / properties / confirm
      Removed value: -{
      -  "const": true,
      -  "description": "True only after authorization for this store and exact change.",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / dryRun
      Added value: +{
      +  "default": true,
      +  "description": "True (the default) returns a before/after preview without changing anything in Shopify. Pass false, after the user authorizes this store and exact change, to apply it; the tool then reads the result back.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / image / properties / url / format
      Previous value: -"uri"New value: +"starts_with"
    • changedInput schema / required
      Previous value: -[
      -  "store",
      -  "id",
      -  "confirm"
      -]New value: +[
      +  "store",
      +  "id"
      +]
  2. Addedv1.6.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false, so safety is partly covered. The description adds genuinely new behavior: dryRun defaults to true and returns a preview, whereas dryRun:false applies the change and returns before/after state. It still omits permission/authorization or blast-radius details beyond the schema's dryRun note.

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

Conciseness4/5

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

Two tightly written sentences with the mutation scope front-loaded and the dryRun semantics immediately after. Dense and free of filler, though the second sentence is long enough that it reads more like a schema clarification than a standalone guide.

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

Completeness3/5

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

For a 9-parameter destructive mutation with no output schema and 22% schema coverage, the description adequately covers the commit/preview mechanic and return shape but leaves several documented-only-in-schema fields (title, sortOrder, descriptionHtml, ruleSet) unexplained. It is minimum viable rather than complete.

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

Parameters3/5

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

Schema description coverage is only 22%, so the description must carry more of the burden. It explains addProductIds (manual-collection semantics) and the dryRun flag, and names image and rules loosely, but never clarifies title, sortOrder, descriptionHtml, the id gid format, or the ruleSet structure.

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

Purpose4/5

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

Specific verb + resource ('Update collection fields, rules or image'), and it enumerates the collection-specific operations including adding products to a manual collection. It does not explicitly contrast with siblings like shopify_update_product or shopify_create_collection, but the resource and field list make the intended target unambiguous.

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

Usage Guidelines3/5

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

Usage is implied (you call this to modify an existing collection) and the dryRun default gives a preview-first workflow, but there is no explicit when-to-use/when-not guidance or routing to alternatives such as shopify_graphql_mutation or shopify_create_collection. The agent must infer when applying versus previewing is appropriate.

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