Official Shopify Dev MCP Server

The Shopify Dev MCP Server (@anthropic-ai/shopify-dev-mcp) is the official Model Context Protocol server built collaboratively by Shopify and Anthropic. It gives AI assistants deep access to Shopify's developer documentation, API schemas, Liquid templates, and Functions scaffolding -- all through natural language.

Why This Server Is Essential

This is the single most impactful tool you can add to your Shopify development workflow. It eliminates the need to manually search docs, cross-reference API versions, or guess at Liquid syntax. Your AI assistant gets the same knowledge a senior Shopify developer would have, always current with the latest API version.

Overview

Detail	Value
Package	`@anthropic-ai/shopify-dev-mcp`
npm	npmjs.com/package/@anthropic-ai/shopify-dev-mcp
GitHub	github.com/anthropics/shopify-dev-mcp
Maintained by	Anthropic + Shopify Developer Relations
Transport	stdio (local)
Auth Required	No (documentation is public)
Latest Version	Check npm for current version
Node.js	18+ required

Core Capabilities

1. Documentation Search

Search across the entire Shopify developer documentation corpus, including:

Admin API reference (GraphQL and REST)
Storefront API reference
App development guides
Theme development docs
Hydrogen and Oxygen docs
Shopify Functions docs
Checkout extensibility guides
Partner documentation

Example prompt:
"Search the Shopify docs for how to implement a delivery customization function"

2. API Schema Exploration

Explore the full GraphQL schema for any Shopify API version:

Browse types, queries, mutations, and subscriptions
View field-level documentation and deprecation notices
Compare schemas across API versions
Understand input types and required fields

Example prompt:
"Show me the ProductInput type for the 2026-01 API version.
What fields are required vs optional?"

3. Liquid Validation and Reference

Access complete Liquid template language documentation:

Object properties and filters
Tag syntax and behavior
Section and block schemas
Theme architecture patterns

Example prompt:
"What Liquid filters are available for formatting money in Shopify?
Show me examples with multi-currency support."

4. Functions Scaffolding

Get guidance on Shopify Functions development:

Available function APIs and their input/output schemas
Rust and JavaScript implementation patterns
Testing strategies for functions
Deployment workflows

Example prompt:
"Help me scaffold a delivery customization function that blocks
shipping to PO boxes for oversized items."

Setup Instructions

Claude Code (Recommended)

Claude Code has first-class MCP support. Setup takes one command:

# Add the server to your project
claude mcp add shopify-dev -- npx -y @anthropic-ai/shopify-dev-mcp@latest

This adds the server configuration to your project's .claude/ directory. The server starts automatically when Claude Code launches.

Verify the connection:

# Start Claude Code
claude

# Then ask:
> What Shopify MCP tools do you have available?

Global installation (available in all projects):

claude mcp add --scope user shopify-dev -- npx -y @anthropic-ai/shopify-dev-mcp@latest

Claude Code Scope Options

--scope project (default): Available only in the current project. Config stored in .claude/.
--scope user: Available globally. Config stored in ~/.claude/.

Cursor

Add the following to your Cursor MCP configuration file:

macOS/Linux: ~/.cursor/mcp.json Windows: %APPDATA%\Cursor\mcp.json

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

After saving, restart Cursor. The MCP server icon should appear in the Composer panel.

Claude Desktop

macOS:

Edit ~/Library/Application Support/Claude/claude_desktop_config.json:

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

Windows:

Edit %APPDATA%\Claude\claude_desktop_config.json:

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

After saving, restart Claude Desktop. You should see a hammer icon in the chat input, indicating MCP tools are available.

Codex (OpenAI)

OpenAI Codex supports MCP servers through its configuration:

# Add to your Codex project configuration
codex mcp add shopify-dev -- npx -y @anthropic-ai/shopify-dev-mcp@latest

Or manually edit your Codex MCP config:

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

Windsurf

Add to your Windsurf MCP configuration:

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

Tool Reference

The Shopify Dev MCP server exposes the following tools:

`search_docs`

Search across all Shopify developer documentation.

Parameter	Type	Required	Description
`query`	string	Yes	Search query text
`topic`	string	No	Filter by topic area: `admin-api`, `storefront-api`, `hydrogen`, `functions`, `themes`, `apps`, `checkout`
`version`	string	No	API version filter (e.g., `2026-01`)

Example usage:

Search Shopify docs for "metafield definitions" filtered to admin-api

The tool returns relevant documentation snippets with source URLs, organized by relevance.

`explore_api_schema`

Explore the Shopify GraphQL API schema.

Parameter	Type	Required	Description
`type_name`	string	No	Specific GraphQL type to explore (e.g., `Product`, `OrderInput`)
`query`	string	No	Search for types matching a pattern
`api`	string	No	Which API: `admin` (default), `storefront`
`version`	string	No	API version (defaults to latest stable)

Example usage:

Explore the admin API schema for the ProductVariant type in version 2026-01

Returns type definitions, field descriptions, argument details, and related types.

`get_liquid_reference`

Access Liquid template language documentation.

Parameter	Type	Required	Description
`object`	string	No	Liquid object name (e.g., `product`, `cart`, `customer`)
`filter`	string	No	Liquid filter name (e.g., `money`, `img_url`, `date`)
`tag`	string	No	Liquid tag name (e.g., `for`, `if`, `section`)

Example usage:

Get the Liquid reference for the product object -- show me all available properties

`get_function_reference`

Get Shopify Functions API reference and scaffolding.

Parameter	Type	Required	Description
`function_type`	string	No	Function API type: `delivery-customization`, `payment-customization`, `discount`, `cart-transform`, `fulfillment-constraints`, `order-routing-location-rule`, `validation`
`language`	string	No	Implementation language: `rust`, `javascript`

Example usage:

Get the function reference for a discount function implemented in JavaScript.
Show me the input schema and expected output format.

`validate_graphql`

Validate a GraphQL query or mutation against the Shopify schema.

Parameter	Type	Required	Description
`query`	string	Yes	The GraphQL query/mutation to validate
`api`	string	No	`admin` or `storefront`
`version`	string	No	API version to validate against

Example usage:

Validate this GraphQL mutation against the admin API:

mutation {
  productCreate(input: { title: "Test Product" }) {
    product { id title }
    userErrors { field message }
  }
}

Real-World Usage Examples

Example 1: Scaffolding a New App

I'm building a Shopify app that syncs inventory across multiple locations.
Search the docs for:
1. The inventory management APIs
2. Webhook topics related to inventory changes
3. Best practices for real-time inventory sync

Then show me the GraphQL mutations I'll need.

Example 2: Debugging a Liquid Theme Issue

My product page isn't showing variant-specific metafields.
Get the Liquid reference for:
1. The product.variants object
2. How to access metafields on variants
3. The metafield Liquid filter

Show me a working code example.

Example 3: Migrating to a New API Version

I need to migrate my app from API version 2025-07 to 2026-01.
What breaking changes affect the Product type?
Show me the deprecated fields I need to update
What new fields are available?

Example 4: Building a Checkout Extension

Search the Shopify docs for checkout UI extensions.
I need to:
1. Add a custom field to collect a gift message
2. Validate the input before order placement
3. Store the value as an order metafield

Show me the extension targets I need and example code.

Tips for Effective Use

Best Practices

Be specific with queries -- "product creation mutation with media" yields better results than "products"
Specify API versions -- Always mention your target version to avoid deprecated patterns
Combine tools -- Search docs first, then explore the schema, then validate your query
Use topic filters -- Narrow results to the relevant area (admin-api, themes, functions, etc.)
Iterate on results -- If the first search is too broad, refine with additional context

Prompt Patterns That Work Well

# Pattern: Research then build
"Search Shopify docs for [topic]. Based on what you find,
write a [component/function/mutation] that [requirement]."

# Pattern: Schema-first development
"Explore the [TypeName] in the admin API schema.
Show me all required fields, then write a mutation using them."

# Pattern: Validation loop
"Here's my GraphQL mutation: [code]. Validate it against the
2026-01 schema and fix any issues."

# Pattern: Cross-reference
"Search docs for [topic] and also explore the schema for
[related type]. How do these work together?"

Troubleshooting

Server fails to start

Error: Cannot find module '@anthropic-ai/shopify-dev-mcp'

Fix: Ensure Node.js 18+ is installed and npx can access npm packages:

node --version  # Should be 18+
npx -y @anthropic-ai/shopify-dev-mcp@latest --help

Tools not appearing in Claude Code

Fix: Verify the MCP configuration:

claude mcp list

If shopify-dev is not listed, re-add it:

claude mcp remove shopify-dev
claude mcp add shopify-dev -- npx -y @anthropic-ai/shopify-dev-mcp@latest

Stale documentation results

The server caches documentation for performance. If you suspect stale results:

# Remove and re-add to get the latest server version
claude mcp remove shopify-dev
claude mcp add shopify-dev -- npx -y @anthropic-ai/shopify-dev-mcp@latest

Slow responses

Documentation search may take 2-5 seconds depending on query complexity. Schema exploration is typically faster. If responses are consistently slow:

Check your internet connection (the server fetches from Shopify's docs)
Try more specific queries to reduce result set size
Ensure you are running the latest server version

What This Server Does NOT Do

Limitations

The Shopify Dev MCP server provides access to documentation and API schemas. It does not:

Connect to your actual Shopify store
Create, read, update, or delete store data (products, orders, etc.)
Access your store's analytics or reports
Manage your Partner account or apps

For store management capabilities, see our Community MCP Servers guide, which covers servers that connect to the Shopify Admin API.

Updates and Changelog

The server is actively maintained. Major updates typically align with Shopify's quarterly API releases:

API 2026-01 -- Full schema support added
Functions scaffolding -- JavaScript and Rust templates
Checkout extensibility -- Extension target documentation
Liquid 2026 -- Updated object and filter reference

Check the npm page or GitHub releases for the latest changes.

Overview​

Core Capabilities​

1. Documentation Search​

2. API Schema Exploration​

3. Liquid Validation and Reference​

4. Functions Scaffolding​

Setup Instructions​

Claude Code (Recommended)​

Cursor​

Claude Desktop​

Codex (OpenAI)​

Windsurf​

Tool Reference​

search_docs​

explore_api_schema​

get_liquid_reference​

get_function_reference​

validate_graphql​

Real-World Usage Examples​

Example 1: Scaffolding a New App​

Example 2: Debugging a Liquid Theme Issue​

Example 3: Migrating to a New API Version​

Example 4: Building a Checkout Extension​

Tips for Effective Use​

Prompt Patterns That Work Well​

Troubleshooting​

Server fails to start​

Tools not appearing in Claude Code​

Stale documentation results​

Slow responses​

What This Server Does NOT Do​

Updates and Changelog​

Overview

Core Capabilities

1. Documentation Search

2. API Schema Exploration

3. Liquid Validation and Reference

4. Functions Scaffolding

Setup Instructions

Claude Code (Recommended)

Cursor

Claude Desktop

Codex (OpenAI)

Windsurf

Tool Reference

`search_docs`

`explore_api_schema`

`get_liquid_reference`

`get_function_reference`

`validate_graphql`

Real-World Usage Examples

Example 1: Scaffolding a New App

Example 2: Debugging a Liquid Theme Issue

Example 3: Migrating to a New API Version

Example 4: Building a Checkout Extension

Tips for Effective Use

Prompt Patterns That Work Well

Troubleshooting

Server fails to start

Tools not appearing in Claude Code

Stale documentation results

Slow responses

What This Server Does NOT Do

Updates and Changelog