Snapshot a store
snapshot_storeReads 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
| Name | Required | Description | Default |
|---|---|---|---|
| full | No | Include each item's data (can be large). | |
| store | Yes | Store alias, or "dir:<path>" for a snapshot folder made with export_snapshot. | |
| prices | No | products: include variant prices and compare-at prices in what is read, compared and planned. Off by default, since prices usually differ per store. | |
| exclude | No | Drop keys matching any of these globs. | |
| include | No | Only keys matching one of these globs, e.g. ["PRODUCT.custom.*", "faq/*", "fr:*"]. | |
| locales | No | Limit translations to these locales, e.g. ["fr", "de"]. Default: every non-primary locale. | |
| as_drafts | No | 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. | |
| inventory | No | 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. | |
| resources | No | Resource types to include. Default: metafield_definitions, metaobject_definitions, collections, pages, shop_policies, metaobjects, menus, redirects. products, metafields and translations are opt-in. | |
| namespaces | No | Limit metafield values (metafields) to these namespaces. | |
| owner_types | No | 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). | |
| include_reserved | No | 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. | |
| metaobject_types | No | Limit metaobjects to these types. Default: all non-reserved types. |