Implements a Model Context Protocol server enabling interaction with Shopify APIs including Admin GraphQL, Functions, and optional Polaris Web Components, offering tools for documentation search, schema introspection, and GraphQL operation assistance.
Unlock the full potential of Shopify Dev MCP through LangDB's AI Gateway. Get enterprise-grade security, analytics, and seamless integration with zero configuration.
Free tier available • No credit card required
This project implements a Model Context Protocol (MCP) server that interacts with Shopify Dev. This protocol supports various tools to interact with different Shopify APIs. At the moment the following APIs are supported:
To run the Shopify MCP server using npx, use the following command:
npx -y @shopify/dev-mcp@latest
Add the following configuration. For more information, read the Cursor MCP documentation or the Claude Desktop MCP guide.
{ "mcpServers": { "shopify-dev-mcp": { "command": "npx", "args": ["-y", "@shopify/dev-mcp@latest"] } } }
On Windows, you might need to use this alternative configuration:
{ "mcpServers": { "shopify-dev-mcp": { "command": "cmd", "args": ["/k", "npx", "-y", "@shopify/dev-mcp@latest"] } } }
In order to better understand how to improve the MCP server, this package makes instrumentation calls. In order to disable them you can set the OPT_OUT_INSTRUMENTATION
environment variable. In Cursor or Claude Desktop the configuration would look like this:
{ "mcpServers": { "shopify-dev-mcp": { "command": "npx", "args": ["-y", "@shopify/dev-mcp@latest"], "env": { "OPT_OUT_INSTRUMENTATION": "true" } } } }
If you want Cursor or Claude Desktop to surface Polaris Web Components documentation, include an env
block with the POLARIS_UNIFIED
flag in your MCP server configuration:
{ "mcpServers": { "shopify-dev-mcp": { "command": "npx", "args": ["-y", "@shopify/dev-mcp@latest"], "env": { "POLARIS_UNIFIED": "true" } } } }
This MCP server provides the following tools:
Tool Name | Description |
---|---|
search_dev_docs | Search shopify.dev documentation |
introspect_admin_schema | Access and search Shopify Admin GraphQL schema |
fetch_docs_by_path | Retrieve documents from shopify.dev |
get_started | Get started with Shopify APIs (Admin, Functions, etc.) |
This MCP server provides the following prompts:
Prompt Name | Description |
---|---|
shopify_admin_graphql | Help you write GraphQL operations for the Shopify Admin API |
The server is built using the MCP SDK and communicates with Shopify Dev.
npm install
npm run build
to compile or npm run build:watch
to watch for changes and compilenpm run test
to run testsnode /dist/index.js
ISC
Discover shared experiences
Shared threads will appear here, showcasing real-world applications and insights from the community. Check back soon for updates!