README - shopify-mcp-server-1 by punkpeye

Shopify MCP Server

GraphQL-powered integration with Shopify Admin API

🚀 Overview

Shopify MCP Server provides a powerful bridge between your applications and the Shopify ecosystem through the Model Context Protocol. Easily manage products, customers, orders, and more with simple API calls to Shopify's Admin API.

📥 Installation

Choose your preferred installation method:

Method	Instructions
Smithery
Glama.ai
NPM	`npm install shopify-mcp-server`

✨ Features

🛍️ Comprehensive Product Management - Search, retrieve, and manage product data
👥 Customer Data Access - Get customer information and manage tags
📦 Advanced Order Processing - Filter, sort, and manage orders easily
⚡ Direct GraphQL Integration - Connect directly to Shopify's Admin API
🛡️ Robust Error Handling - Clear feedback for troubleshooting

🧰 Available Tools

Product Management

Tool	Description	Key Parameters
`get-products`	Find products by title	`searchTitle`, `limit`
`get-products-by-collection`	Get collection products	`collectionId`, `limit`
`get-products-by-ids`	Retrieve specific products	`productIds`
`get-variants-by-ids`	Get variant details	`variantIds`

Customer Management

Tool	Description	Key Parameters
`get-customers`	Retrieve customer data	`limit`, `next`
`tag-customer`	Add tags to customers	`customerId`, `tags`

Order Management

Tool	Description	Key Parameters
`get-orders`	Filter and sort orders	`first`, `after`, `query`, `sortKey`
`get-order`	Get single order details	`orderId`

Shop & Collection Tools

Tool	Description	Key Parameters
`get-collections`	Retrieve shop collections	`limit`, `name`
`get-shop`	Get basic shop details	None
`get-shop-details`	Get extended shop info	None

Discount Management

Tool	Description	Key Parameters
`create-discount`	Create discount codes	`title`, `code`, `valueType`, `value`

🏁 Getting Started

Install the package
```
npm install shopify-mcp-server
```

Set up environment variables

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

Initialize the server
```
require('shopify-mcp-server').start();
```

Make your first API call

const products = await shopifyMcpServer.tools.getProducts({ limit: 10 });
console.log(products);

💡 Use Cases

E-commerce Platform Integration - Sync products and orders between systems
Custom Admin Dashboards - Build tailored interfaces for your business needs
Order Automation - Set up workflows for automatic order processing
Multi-channel Sales Management - Manage inventory across all sales channels

🔧 Setup Guide

Getting a Shopify Access Token

From your Shopify admin, go to Settings > Apps and sales channels
Click Develop apps > Create an app
Name your app (e.g., "Shopify MCP Server")
Configure API scopes:
- read_products, write_products
- read_customers, write_customers
- read_orders, write_orders
Click Save and Install app
Copy your Admin API access token

Security Note: Store your access token securely. Never commit it to version control.

Using with Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "shopify": {
      "command": "npx",
      "args": ["-y", "shopify-mcp-server"],
      "env": {
        "SHOPIFY_ACCESS_TOKEN": "<TOKEN>",
        "MYSHOPIFY_DOMAIN": "<SHOP>.myshopify.com"
      }
    }
  }
}

👨‍💻 Development

# Clone the repository
git clone https://github.com/your-username/shopify-mcp-server.git

# Install dependencies
cd shopify-mcp-server
npm install

# Set up environment variables
# Create a .env file with your Shopify credentials

# Build and test
npm run build
npm test

🤝 Community

Resource	Link
GitHub Discussions	Join the conversation
Issue Tracker	Report bugs
Twitter	@rezajafar
Discord	Join our server

Built with ❤️ using the Model Context Protocol