@shopify/dev-mcp weekly downloads statistics

Shopify Dev MCP Server

@shopify/dev-mcp is Shopify's Model Context Protocol server for building on the Shopify platform. It lets AI agents search Shopify's documentation and API schemas, validate GraphQL operations, Liquid and theme files, and UI-extension code, and resolve supported API versions.

For setup instructions across editors and agents, see Shopify AI Toolkit on shopify.dev.

Run the server

The server requires Node.js 18 or later and runs locally over standard input/output without authentication:

npx -y @shopify/dev-mcp@latest

Most MCP clients launch it with this configuration:

{
  "mcpServers": {
    "shopify-dev-mcp": {
      "command": "npx",
      "args": ["-y", "@shopify/dev-mcp@latest"]
    }
  }
}

On Windows, use this configuration if Cursor reports connection errors:

{
  "mcpServers": {
    "shopify-dev-mcp": {
      "command": "cmd",
      "args": ["/k", "npx", "-y", "@shopify/dev-mcp@latest"]
    }
  }
}

The Shopify AI Toolkit setup guide includes client-specific instructions for Claude Code, Codex CLI, Antigravity CLI, Cursor, and VS Code. Installing the full AI Toolkit plugin is recommended when your client supports it.

Configuration

LIQUID_VALIDATION_MODE defaults to full, which exposes validate_theme for validating entire theme directories. Set it to partial to validate individual code blocks instead: validate_theme is not registered, and liquid joins the api enum of the merged validate tool.

Shopify developer authoring search

A source build can search one selected local Shopify.dev worktree by setting SHOPIFY_DEV_LOCAL_SERVER_URL to that worktree's HTTPS URL, or to loopback HTTP(S) with an explicit port. Run Shopify.dev's local:ready check first. Published npm builds reject this setting.

Authoring mode affects search_docs_chunks; private eval Skills use the same route through search_docs. See local-search evals. Bundled API instructions, validation schemas, version catalogs, published skills, and direct shopify doc fetch calls don't read the unpublished corpus through this setting.

Telemetry

Published release builds send usage events to https://shopify.dev/mcp/usage. Events can include tool inputs and results, API and package version metadata, a random conversation ID, and client or model identifiers supplied by the MCP host. Builds run from source send nothing.

To opt out across Shopify AI Toolkit surfaces, create an empty user-level opt-out file (recommended):

mkdir -p ~/.config/shopify-ai-toolkit
touch ~/.config/shopify-ai-toolkit/opt-out

On Windows, create %APPDATA%\shopify-ai-toolkit\opt-out. Alternatively, set OPT_OUT_INSTRUMENTATION=true or DO_NOT_TRACK=1 in the environment that launches the server.

See the Shopify AI Toolkit telemetry documentation for configuration examples and platform-specific paths.

Support

For questions and troubleshooting, visit the Shopify Developer Community.

License

ISC