Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
SHOPIFY_STORESNoWhole store configuration as JSON. Alternative to a stores.json file.
SYNC_AUDIT_LOGNoOverride path for the JSONL audit log.~/.shopify-store-sync/audit.log
SHOPIFY_STORES_FILENoPath to a stores.json configuration file elsewhere. If omitted, the server can use stores.json in the working directory.
SHOPIFY_ACCESS_TOKENNoShopify Admin API access token for single-store configuration; used together with SHOPIFY_STORE_DOMAIN.
SHOPIFY_STORE_DOMAINNoShopify store domain for single-store configuration; used together with SHOPIFY_ACCESS_TOKEN.

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

Syncs configuration between Shopify stores. Use this order: list_stores to see the stores and which accept writes, diff_stores (or compare_item for one item) to see what differs, plan_sync to build a dry-run plan, show the plan to the person, then apply_plan only after they approve it. Nothing is written to Shopify except by apply_plan, and it never deletes. A protected store asks the person to confirm; never try to confirm for them. Large applies run in the background: follow them with apply_status, stop them with cancel_apply, and read what was written with get_audit_log. snapshot_store returns a store's configuration in the response; export_snapshot saves it to files for git instead.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
list_storesA

List the Shopify stores this server is configured for. Call it first: the aliases it returns are the store names every other tool takes (source, target, store). Returns { server, stores: [{ alias, domain, label, apiVersion, auth, allowWrites, protected }] }. allowWrites=false means apply_plan refuses that store; protected=true means a person confirms every apply to it. An empty list means no store is set up yet. Tokens and secrets are never returned. Takes no arguments and makes no Shopify calls. Next: list_resource_types for what can be synced, diff_stores to compare two stores.

list_resource_typesA

List the resource types this server can snapshot, diff and sync (metafield definitions, metaobjects, pages, menus, products...). Returns [{ kind, default, description }]: kind is the value to pass in the resources argument of snapshot_store, export_snapshot, diff_stores and plan_sync; default tells whether it is read when resources is omitted; description says how items are keyed and what is copied. Use it to choose resources; use list_stores for the stores themselves. Takes no arguments and makes no Shopify calls.

snapshot_storeA

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.

export_snapshotA

Save a store's configuration to a folder on disk, one JSON file per item (sorted keys, no store IDs), ready to commit to git. dir must be new, empty, or an earlier snapshot folder (its item files are replaced); any other folder is refused. Returns a summary { dir, files, kinds } with the count per resource type, not the data; to see the data in the response use snapshot_store. Later, pass "dir:" as the source of diff_stores or plan_sync to compare against it or restore from it. Reads the store and writes only local files, never to Shopify.

diff_storesA

Compare configuration between a source and a target, resource type by resource type. Returns for each type the counts (onlyInSource, changed, onlyInTarget, identical) and the keys in each section, with before and after values for every changed field (show_values=false keeps only the field paths); limit caps each list while the counts cover everything, and format="markdown" gives a report to share. Either side can be a snapshot folder ("dir:"), e.g. to check whether production drifted from the committed config. The options shared with plan_sync (resources, include, prices, inventory, as_drafts...) only decide what is read and compared, so the diff matches the plan the same options would produce; nothing is written. Use compare_item for a single item, diff_themes for theme settings, and plan_sync to prepare the changes.

compare_itemA

Compare a single item between two stores, side by side: whether each has it, every field that differs (entry by entry inside JSON values), and whether the items it points at (products, pages, metaobjects...) exist in the target. Reads only that item where possible, so it is quick. Returns { status (identical, different, only in source, only in target, in neither), changes, refs, notCompared }. Use it for a targeted check instead of diff_stores; take the key from a diff_stores result.

plan_syncA

Build a dry-run plan that would make the target store match the source (a store or a "dir:" snapshot folder) for the selected resources. Reads both sides and writes nothing. Returns { plan_id, expiresAt, totals (create, update, conflict), byResource, ops, warnings, filesToUpload, onlyInTarget, targetWritable, targetProtected }; each op has a seq number, key, action, reason, missing references and field changes (the first 200 ops are listed). Conflicts are items that can't be written, with the reason; items only in the target are listed and never deleted. Show the plan to the person, then pass plan_id to apply_plan; it expires after one hour, and get_plan shows it again. To only look at differences, use diff_stores instead.

get_planA

Show a sync plan made by plan_sync, before or after it is applied. With plan_id: the plan as plan_sync returned it (totals, ops with field changes, warnings, expiry) plus, once applied, the apply's state and totals; only the first 200 ops are listed and long values are shortened unless full=true, and format="markdown" gives a report to share for review. Without plan_id: the 20 most recent plans (plan_id, createdAt, status, source, target, op count), to find one. To create a plan use plan_sync, to write it use apply_plan, and to follow a running apply use apply_status. Reads only the plans saved by this server, nothing from Shopify.

apply_planA

Write a reviewed plan to the target store. Refused unless the target has allowWrites=true. For a protected store the person is asked to confirm in the client (or applies from the command line); the assistant can't confirm on their behalf. Re-reads the target first and skips anything that changed since planning. Uploads missing files. Creates and updates only, never deletes. Every op is written to the audit log (get_audit_log). Returns { plan_id, status, totals (created, updated, skipped, failed), results per op }; a plan of more than 50 steps runs in the background instead and returns at once: follow it with apply_status and stop it with cancel_apply. A plan can be applied once, within an hour of plan_sync.

apply_statusA

How far an apply has got: steps created, updated, skipped, failed and left per resource type, the current phase, progress inside a Shopify bulk operation, time so far and an estimate of the time left, failures counted per resource type and reason, and the latest failures. Also answers for an apply that ended or was interrupted by a server restart. Call it after apply_plan returns a background apply, every minute or so until state is done or error. resource narrows only the listed failures; the counts always cover every resource type. For what each step wrote use get_audit_log, to stop the apply use cancel_apply, and for what was planned use get_plan.

cancel_applyA

Stop an apply that is running in the background: no further step is started and the Shopify bulk operations it started are cancelled. What was already written stays written (nothing is rolled back or deleted). Also stops bulk operations left running by an apply whose server was restarted. If the apply has already ended, nothing is cancelled and its final state is returned. Returns { plan_id, state (cancelling, or interrupted for an apply from before a restart), note }. Follow with apply_status, then plan_sync to see what is left.

get_audit_logA

Read what apply_plan wrote: the most recent audit log entries, newest first, one per step (plan, target store, resource type, key, outcome and message). Filter by plan, outcome (created, updated, skipped, failed) or resource type. Returns { log (file path), matched, returned, entries }: limit (default 50) caps the entries while matched counts every match; in a very large log only the most recent 8 MB is searched. Use it after an apply to see exactly what was written; use apply_status for the progress of a running apply and get_plan for what a plan intended. The log is a local file; nothing is read from Shopify.

diff_themesA

Compare theme configuration between two stores: JSON templates, section groups and settings_data.json (default files: templates/.json, sections/.json, config/settings_data.json). Use it for theme settings; use diff_stores for store data such as metafields, metaobjects and pages. Compares the published themes unless source_theme or target_theme give theme ids. Returns file counts (onlyInSource, changed, onlyInTarget, identical), the files on one side only, and for each changed file the settings that differ with both values (first 100 per file); format="markdown" gives a report. Use ignore_settings to quiet settings that differ on purpose. Never writes to a theme; both stores need the read_themes scope.

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

TDQS

A4.4/5.0

Scored across 13 tools

Disambiguation5/5

Each tool has a distinct role in a clear pipeline: discovery (list_stores, list_resource_types), inspection (snapshot_store, export_snapshot), comparison (diff_stores, compare_item, diff_themes), planning (plan_sync, get_plan), execution (apply_plan, apply_status, cancel_apply) and audit (get_audit_log). The potentially confusable cluster (snapshot vs export vs diff vs compare) is explicitly delimited in every description with 'use X for..., use Y for...' guidance.

Naming Consistency4/5

Most names follow a predictable verb_noun pattern (list_stores, snapshot_store, export_snapshot, diff_stores, compare_item, apply_plan, get_audit_log). A couple of deviations break the pattern — plan_sync is noun_verb rather than create_plan/plan_changes, and apply_status reads like a status noun rather than get_apply_status — but the overall scheme stays readable.

Tool Count5/5

13 tools is well within the ideal range and each maps to a needed stage of the sync lifecycle; nothing looks redundant or padded. Read-only inspection, planning, applying, monitoring and auditing each justify their slots.

Completeness4/5

Coverage is strong: discovery, snapshot/export, diff, dry-run planning, gated apply, progress tracking, cancellation and audit logging, plus restore-from-folder via 'dir:<path>' sources. The main gap is diff_themes, which compares theme files but has no corresponding apply tool, so theme changes are a dead end; deletion is also absent, though that is an explicitly stated design choice.

Maintenance

ActivityMaintained
ResponsivenessNo recent community issues