Skip to main content
Glama

Snapshot a store

snapshot_store
Read-only

Reads a single Shopify store's configuration and returns it in portable form with store IDs replaced by handles, so you can inspect resources and keys before exporting or comparing stores.

Instructions

Read one store's configuration (or a snapshot folder made with export_snapshot) and return it in the response, in portable form with store IDs replaced by handles. Returns { store, domain, takenAt, resources: [{ kind, count, items }] }: items are keys only, or { key, data } with full=true, which can be large, so narrow first with resources, include or the other filters. Use it to inspect one store; to save the configuration to files use export_snapshot, and to compare two stores use diff_stores. Writes nothing.

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": {
      "store": "<store>"
    },
    "name": "snapshot_store"
  }
}

Input Schema

NameRequiredDescriptionDefault
fullNoInclude each item's data (can be large).
storeYesStore alias, or "dir:<path>" for a snapshot folder made with export_snapshot.
pricesNoproducts: include variant prices and compare-at prices in what is read, compared and planned. Off by default, since prices usually differ per store.
excludeNoDrop keys matching any of these globs.
includeNoOnly keys matching one of these globs, e.g. ["PRODUCT.custom.*", "faq/*", "fr:*"].
localesNoLimit translations to these locales, e.g. ["fr", "de"]. Default: every non-primary locale.
as_draftsNoLeave the published state out of what is compared and copied: in a plan, new pages are created hidden and new metaobject entries as drafts, and existing ones keep their state. Products are always created as drafts.
inventoryNoproducts: include stock (the available quantity per location, matched to the target's location with the same name) in what is read, compared and planned. Off by default. Needs read_inventory and read_locations, plus write_inventory to apply: run connect again if the sign-in is older.
resourcesNoResource types to include. Default: metafield_definitions, metaobject_definitions, collections, pages, shop_policies, metaobjects, menus, redirects. products, metafields and translations are opt-in.
namespacesNoLimit metafield values (metafields) to these namespaces.
owner_typesNoMetafield owner types. For metafield_definitions, default: PRODUCT, PRODUCTVARIANT, COLLECTION, CUSTOMER, ORDER, DRAFTORDER, COMPANY, COMPANY_LOCATION, LOCATION, MARKET, PAGE, BLOG, ARTICLE, SHOP. For metafield values (metafields): PRODUCT, COLLECTION, PRODUCTVARIANT, SHOP (all by default).
include_reservedNometafield_definitions: also compare Shopify-reserved ones (namespace "shopify", the category metafields that drive storefront filters). Compared only: a plan reports them as conflicts and never writes them.
metaobject_typesNoLimit metaobjects to these types. Default: all non-reserved types.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.11.6
    • changedInput schema / properties / as_drafts / description
      Previous value: -"Leave the published state alone: new pages are created hidden and new metaobject entries as drafts, existing ones keep their state. Products are always created as drafts."New value: +"Leave the published state out of what is compared and copied: in a plan, new pages are created hidden and new metaobject entries as drafts, and existing ones keep their state. Products are always created as drafts."
    • changedInput schema / properties / inventory / description
      Previous value: -"products: also copy stock, the available quantity per location, into the target's location with the same name. Off by default. Needs read_inventory and read_locations (and write_inventory to write): run connect again if the sign-in is older."New value: +"products: include stock (the available quantity per location, matched to the target's location with the same name) in what is read, compared and planned. Off by default. Needs read_inventory and read_locations, plus write_inventory to apply: run connect again if the sign-in is older."
    • changedInput schema / properties / prices / description
      Previous value: -"products: also copy variant prices and compare-at prices. Off by default, since prices usually differ per store."New value: +"products: include variant prices and compare-at prices in what is read, compared and planned. Off by default, since prices usually differ per store."
  2. Changed11 schema fields changedv0.11.4
    • addedInput schema / properties / as_drafts
      Added value: +{
      +  "description": "Leave the published state alone: new pages are created hidden and new metaobject entries as drafts, existing ones keep their state. Products are always created as drafts.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / include / description
      Previous value: -"Only keys matching one of these globs, e.g. [\"PRODUCT.custom.*\", \"faq/*\", \"main-menu\"]."New value: +"Only keys matching one of these globs, e.g. [\"PRODUCT.custom.*\", \"faq/*\", \"fr:*\"]."
    • addedInput schema / properties / include_reserved
      Added value: +{
      +  "description": "metafield_definitions: also compare Shopify-reserved ones (namespace \"shopify\", the category metafields that drive storefront filters). Compared only: a plan reports them as conflicts and never writes them.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / inventory
      Added value: +{
      +  "description": "products: also copy stock, the available quantity per location, into the target's location with the same name. Off by default. Needs read_inventory and read_locations (and write_inventory to write): run connect again if the sign-in is older.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / locales
      Added value: +{
      +  "description": "Limit translations to these locales, e.g. [\"fr\", \"de\"]. Default: every non-primary locale.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / namespaces
      Added value: +{
      +  "description": "Limit metafield values (metafields) to these namespaces.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / owner_types / description
      Previous value: -"Metafield owner types for metafield_definitions. Default: PRODUCT, PRODUCTVARIANT, COLLECTION, CUSTOMER, ORDER, DRAFTORDER, COMPANY, COMPANY_LOCATION, LOCATION, MARKET, PAGE, BLOG, ARTICLE, SHOP."New value: +"Metafield owner types. For metafield_definitions, default: PRODUCT, PRODUCTVARIANT, COLLECTION, CUSTOMER, ORDER, DRAFTORDER, COMPANY, COMPANY_LOCATION, LOCATION, MARKET, PAGE, BLOG, ARTICLE, SHOP. For metafield values (metafields): PRODUCT, COLLECTION, PRODUCTVARIANT, SHOP (all by default)."
    • addedInput schema / properties / prices
      Added value: +{
      +  "description": "products: also copy variant prices and compare-at prices. Off by default, since prices usually differ per store.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / resources / description
      Previous value: -"Resource types to include. Default: all (metafield_definitions, metaobject_definitions, pages, metaobjects, menus, redirects)."New value: +"Resource types to include. Default: metafield_definitions, metaobject_definitions, collections, pages, shop_policies, metaobjects, menus, redirects. products, metafields and translations are opt-in."
    • changedInput schema / properties / resources / items / enum
      Previous value: -[
      -  "metafield_definitions",
      -  "metaobject_definitions",
      -  "pages",
      -  "metaobjects",
      -  "menus",
      -  "redirects"
      -]New value: +[
      +  "metafield_definitions",
      +  "metaobject_definitions",
      +  "products",
      +  "collections",
      +  "pages",
      +  "shop_policies",
      +  "metaobjects",
      +  "menus",
      +  "redirects",
      +  "metafields",
      +  "translations",
      +  "discounts"
      +]
    • changedInput schema / properties / store / description
      Previous value: -"Store alias from list_stores"New value: +"Store alias, or \"dir:<path>\" for a snapshot folder made with export_snapshot."
  3. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, and the description reinforces this with 'Writes nothing' while adding real behavioral context: output is portable with store IDs replaced by handles, and full=true can be large so results should be narrowed first. It stops short of covering error modes or auth requirements, which keeps it at 4 rather than 5.

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?

The sentence order is well front-loaded: purpose and portability first, return shape second, narrowing advice third, sibling routing last. It is dense but every sentence carries information; the inline return-shape notation is compact rather than verbose.

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?

With 13 parameters, a dual input mode (store alias vs. dir:<path>), no output schema, and a variable-size payload, the description supplies exactly what is missing: the response envelope, the keys-vs-data distinction, and the size warning. Nothing essential for a correct first call is absent.

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 the baseline is 3, but the description adds meaning on top: it explains the items shape (keys only vs. { key, data } with full=true) and gives concrete narrowing advice via resources/include and 'the other filters'. It does not restate the per-parameter defaults, which the schema already covers.

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?

States a specific verb and resource: read one store's configuration (or an export_snapshot folder) and return it in portable form with IDs replaced by handles. It explicitly separates itself from export_snapshot (saving to files) and diff_stores (comparing two stores), so the agent can choose without opening schemas.

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?

Names the intended case ('use it to inspect one store') and pairs each alternative with the condition that selects it: export_snapshot for writing to files, diff_stores for comparison. That is explicit when/when-not/alternative guidance.

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