The Shopify Dev MCP Server provides tools to interact with Shopify APIs and access documentation resources:
- Interact with Shopify APIs: Work with Admin GraphQL API, Polaris components, Shopify Functions, Hydrogen, and Storefront Web Components
- Access Documentation: Search across
shopify.dev
documentation usingsearch_dev_docs
and retrieve specific documentation withfetch_docs_by_path
- Explore Admin GraphQL Schema: Use
introspect_admin_schema
to filter and search relevant parts of the Admin API schema - Get Started Guides: Use
learn_shopify_api
for up-to-date API instructions andget_started
to understand which APIs best fit your needs - Development Assistance: Get help writing GraphQL operations and generating valid code blocks for various APIs
- Configuration Options: Opt-in for experimental Polaris Web Components with the
POLARIS_UNIFIED
flag and disable usage tracking withOPT_OUT_INSTRUMENTATION
Enables introspection and searching of the Shopify Admin GraphQL schema, with specialized support for writing GraphQL operations against the Shopify Admin API.
Provides tools for searching Shopify.dev documentation and introspecting the Shopify Admin GraphQL schema. Includes a specialized prompt for writing GraphQL operations for the Shopify Admin API.
Shopify Dev MCP Server
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:
- Admin GraphQL API
- Functions
- (Optional) Polaris Web Components
Setup
To run the Shopify MCP server using npx, use the following command:
Usage with Cursor or Claude Desktop
Add the following configuration. For more information, read the Cursor MCP documentation or the Claude Desktop MCP guide.
On Windows, you might need to use this alternative configuration:
Disable instrumentation
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:
Opt-in Polaris support (experimental)
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:
Available tools
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.) |
Available prompts
This MCP server provides the following prompts:
Prompt Name | Description |
---|---|
shopify_admin_graphql | Help you write GraphQL operations for the Shopify Admin API |
Development
The server is built using the MCP SDK and communicates with Shopify Dev.
npm install
- Modify source files
- Run
npm run build
to compile ornpm run build:watch
to watch for changes and compile - Run
npm run test
to run tests - Add an MCP server that runs this command:
node <absolute_path_of_project>/dist/index.js
License
ISC
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Model Context Protocol (MCP) server that interacts with Shopify Dev. This protocol supports various tools to interact with different Shopify APIs.
Related MCP Servers
- AsecurityFlicenseAqualityA Model Context Protocol (MCP) server that provides programmatic access to the Supabase Management API. This server allows AI models and other clients to manage Supabase projects and organizations through a standardized interface.Last updated -857842JavaScript
Upstash MCP Serverofficial
AsecurityAlicenseAqualityModel Context Protocol (MCP) is a new, standardized protocol for managing context between large language models (LLMs) and external systems. In this repository, we provide an installer as well as an MCP Server for Upstash Developer API's.Last updated -167343TypeScriptMIT License- -securityAlicense-qualityThis MCP server connects clients with Shopify store data, enabling retrieval of product and customer information via exposed tools.Last updated -4PythonMIT License
- -securityAlicense-qualityA Model Context Protocol (MCP) server designed to easily dump your codebase context into Large Language Models (LLMs).Last updated -91JavaScriptApache 2.0