What is Dev Mcp

dev-mcp is a Model Context Protocol (MCP) server designed for interacting with Shopify Dev, facilitating the use of various tools to access different Shopify APIs.

Use cases

Use cases for dev-mcp include developing custom Shopify applications, integrating Shopify functionalities into existing platforms, and enhancing developer productivity through streamlined access to Shopify API documentation and schema.

How to use

To use dev-mcp, run the command ‘npx -y @shopify/dev-mcp@latest’ in your terminal. For integration with Cursor or Claude Desktop, add the specified configuration in JSON format.

Key features

Key features of dev-mcp include tools for searching Shopify.dev documentation and introspecting the Shopify Admin GraphQL schema, as well as prompts for writing GraphQL operations for the Shopify Admin API.

Where to use

dev-mcp is primarily used in the development of applications and tools that require interaction with Shopify APIs, making it suitable for developers working within the Shopify ecosystem.

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:

npx -y @shopify/dev-mcp@latest

Usage with Cursor or Claude Desktop

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"
      ]
    }
  }
}

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:

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

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:

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

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.

1. npm install
2. Modify source files
3. Run npm run build to compile or npm run build:watch to watch for changes and compile
4. Run npm run test to run tests
5. Add an MCP server that runs this command: node <absolute_path_of_project>/dist/index.js

License

ISC