Shopify Theme MCP Server

(please leave a star if you like!)

MCP Server for Shopify API, enabling interaction with store data and theme management through GraphQL API. This server provides comprehensive tools for managing products, customers, orders, and themes.

📦 Package Name: shopify-theme-mcp
🚀 Command: shopify-theme-mcp

Features

• Product Management: Search, retrieve, and manage products by ID or handle
• Collection Management: Load collections with products by handle
• Customer Management: Load customer data and manage customer information
• Order Management: Advanced order querying and filtering
• Theme Management: Create, update, delete, and publish themes
• Theme Files: Manage theme files, assets, and templates
• GraphQL Integration: Direct integration with Shopify's GraphQL Admin API
• Comprehensive Error Handling: Clear error messages for API and authentication issues

Prerequisites

1. Node.js (version 18 or higher)
2. Shopify Custom App Access Token (see setup instructions below)

Setup

Shopify Access Token

To use this MCP server, you'll need to create a custom app in your Shopify store:

1. From your Shopify admin, go to Settings > Apps and sales channels
2. Click Develop apps (you may need to enable developer preview first)
3. Click Create an app
4. Set a name for your app (e.g., "Shopify Theme MCP Server")
5. Click Configure Admin API scopes
6. Select the following scopes:
   • read_products, write_products
   • read_customers, write_customers
   • read_orders, write_orders
   • read_themes, write_themes
   • read_content, write_content
7. Click Save
8. Click Install app
9. Click Install to give the app access to your store data
10. After installation, you'll see your Admin API access token
11. Copy this token - you'll need it for configuration

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "shopify": {
      "command": "npx",
      "args": [
        "shopify-theme-mcp",
        "--accessToken",
        "<YOUR_ACCESS_TOKEN>",
        "--domain",
        "<YOUR_SHOP>.myshopify.com"
      ]
    }
  }
}

Locations for the Claude Desktop config file:

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

Alternative: Run Locally with Environment Variables

If you prefer to use environment variables instead of command-line arguments:

1. Create a .env file with your Shopify credentials:

   SHOPIFY_ACCESS_TOKEN=your_access_token
   MYSHOPIFY_DOMAIN=your-store.myshopify.com

2. Run the server with npx:

   npx shopify-theme-mcp

Direct Installation (Optional)

If you want to install the package globally:

npm install -g shopify-theme-mcp

Then run it:

shopify-theme-mcp --accessToken=<YOUR_ACCESS_TOKEN> --domain=<YOUR_SHOP>.myshopify.com

Available Tools

Product Management

1. get-products

   • Get all products or search by title
   • Inputs:
     • searchTitle (optional string): Filter products by title
     • limit (number): Maximum number of products to return

2. get-product-by-id

   • Get a specific product by ID
   • Inputs:
     • productId (string): ID of the product to retrieve

3. get-product-by-handle

   • Get a product by its handle with complete data including variants, images, and metafields
   • Inputs:
     • handle (string): The product handle to retrieve

Collection Management

1. get-collection-by-handle
   • Get a collection by its handle with complete data including products, rules, and metafields
   • Inputs:
     • handle (string): The collection handle to retrieve
     • includeProducts (boolean, default: false): Whether to include products in the collection
     • productLimit (number, default: 10): Maximum number of products to include (if includeProducts is true)

Customer Management

1. get-customers

   • Get customers or search by name/email
   • Inputs:
     • searchQuery (optional string): Filter customers by name or email
     • limit (optional number, default: 10): Maximum number of customers to return

2. update-customer

   • Update a customer's information
   • Inputs:
     • id (string, required): Shopify customer ID (numeric ID only, like "6276879810626")
     • firstName (string, optional): Customer's first name
     • lastName (string, optional): Customer's last name
     • email (string, optional): Customer's email address
     • phone (string, optional): Customer's phone number
     • tags (array of strings, optional): Tags to apply to the customer
     • note (string, optional): Note about the customer
     • taxExempt (boolean, optional): Whether the customer is exempt from taxes
     • metafields (array of objects, optional): Customer metafields for storing additional data

3. get-customer-orders

   • Get orders for a specific customer
   • Inputs:
     • customerId (string, required): Shopify customer ID (numeric ID only, like "6276879810626")
     • limit (optional number, default: 10): Maximum number of orders to return

Order Management

1. get-orders

   • Get orders with optional filtering
   • Inputs:
     • status (optional string): Filter by order status
     • limit (optional number, default: 10): Maximum number of orders to return

2. get-order-by-id

   • Get a specific order by ID
   • Inputs:
     • orderId (string, required): Full Shopify order ID (e.g., "gid://shopify/Order/6090960994370")

3. update-order

   • Update an existing order with new information
   • Inputs:
     • id (string, required): Shopify order ID
     • tags (array of strings, optional): New tags for the order
     • email (string, optional): Update customer email
     • note (string, optional): Order notes
     • customAttributes (array of objects, optional): Custom attributes for the order
     • metafields (array of objects, optional): Order metafields
     • shippingAddress (object, optional): Shipping address information

Theme Management

1. get-themes

   • List all themes in the store
   • Inputs:
     • role (optional enum): Filter by theme role (MAIN, UNPUBLISHED, DEMO)
     • limit (optional number, default: 10): Maximum number of themes to return

2. get-theme-assets

   • Retrieve theme assets
   • Inputs:
     • themeId (string): The theme ID to get assets from
     • assetKey (optional string): Specific asset key to retrieve

3. get-theme-files

   • Get theme files with optional content retrieval
   • Inputs:
     • themeId (string): The theme ID to get files from
     • filename (optional string): Specific filename to retrieve content
     • directory (optional string): Filter files by directory (templates, sections, assets, etc.)

4. update-theme-file

   • Create or update theme files
   • Inputs:
     • themeId (string): The theme ID to update
     • filename (string): The filename/path to create or update
     • value (optional string): File content for text files
     • src (optional string): Source URL for asset files
     • attachment (optional string): Base64 encoded file content

5. delete-theme-file

   • Delete theme files
   • Inputs:
     • themeId (string): The theme ID to delete files from
     • filenames (array of strings): List of filenames to delete

6. create-theme

   • Create a new theme
   • Inputs:
     • name (string): Theme name
     • src (optional string): Source ZIP file URL
     • role (optional enum): Theme role (MAIN or UNPUBLISHED)

7. publish-theme

   • Publish a theme to make it live
   • Inputs:
     • themeId (string): The theme ID to publish

Debugging

If you encounter issues, check Claude Desktop's MCP logs:

tail -n 20 -f ~/Library/Logs/Claude/mcp*.log

License

MIT