Shopify

🚀 Shopify MCP Server

Shopify MCP Server is a tool based on the Model Context Protocol (MCP) for interacting with Shopify stores. It offers a series of GraphQL API interfaces, facilitating developers to manage data such as products, customers, and orders.

🚀 Quick Start

Shopify Access Token

To use this server, follow these steps to create a custom app and obtain an access token:

1. Log in to the Shopify admin interface.
2. Navigate to Settings > Apps and sales channels.
3. Click Develop apps (you may need to enable developer preview first).
4. Create a new app, naming it "Shopify MCP Server" or another memorable name.
5. Configure the Admin API permission scope:
   • Read and write products (read_products, write_products)
   • Read and write customers (read_customers, write_customers)
   • Read and write orders (read_orders, write_orders)
6. Install the app and obtain the Admin API access token.

⚠️ Important Note

Please keep the access token safe and avoid exposing it or accidentally pushing it to the version control system.

✨ Features

• Powerful GraphQL Support: Directly manipulate Shopify data through GraphQL requests.
• Flexible MCP Protocol: Utilize the MCP's context model protocol for efficient data interaction.
• Multi - scenario Support: Suitable for various business scenarios such as product management, customer relationship maintenance, and order processing.

📦 Installation

Shopify Access Token

To use this server, follow these steps to create a custom app and obtain an access token:

1. Log in to the Shopify admin interface.
2. Navigate to Settings > Apps and sales channels.
3. Click Develop apps (you may need to enable developer preview first).
4. Create a new app, naming it "Shopify MCP Server" or another memorable name.
5. Configure the Admin API permission scope:
   • Read and write products (read_products, write_products)
   • Read and write customers (read_customers, write_customers)
   • Read and write orders (read_orders, write_orders)
6. Install the app and obtain the Admin API access token.

💻 Usage Examples

Basic Usage

In Claude Desktop, use this server as follows:

1. Create or edit the claude_desktop_config.json file.
2. Add the following configuration:

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

3. Start the server and begin using the relevant tools.

📚 Documentation

Tool List

The following are the main tools provided by the server:

Product Management

1. get-products: Retrieve product information under specified conditions.
2. create-product: Create a new product.
3. update-product: Update the detailed information of an existing product.
4. delete-product: Delete a specified product.

Customer Management

5. get-customers: List all customer information.
6. create-customer: Add a new customer.
7. update-customer: Modify customer profiles.
8. delete-customer: Remove a specified customer.

Order Processing

9. get-orders: Get the order list.
10. create-order: Generate a new order.
11. update-order: Update the order status or information.
12. cancel-order: Cancel an incomplete order.

Other Functions

13. get-collections: Retrieve product collection information.
14. manage-webhook: Subscribe to, find, or cancel webhook events.
15. get-shop: Get the basic information of the store.
16. get-shop-details: Get the detailed configuration of the store, including available shipping countries, etc.

Development

Project Structure

1. Clone the repository:

   git clone https://github.com/your-username/shopify-mcp-server.git
   cd shopify-mcp-server
   

2. Install dependencies:

   npm install
   

3. Create a .env file:

   SHOPIFY_ACCESS_TOKEN=<your access token>
   MYSHOPIFY_DOMAIN=<your-store>.myshopify.com
   

4. Start the development server:

   npm start
   

Dependencies

• graphql: GraphQL client library.
• axios: HTTP request library.
• dotenv: Environment variable loading tool.

🔧 Technical Details

The Shopify MCP Server is a tool based on the Model Context Protocol (MCP) for interacting with Shopify stores. It provides a series of GraphQL API interfaces, which can be used to manage data such as products, customers, and orders. The server uses GraphQL for data query and manipulation, and the MCP protocol for efficient data interaction.

📄 License

This project is licensed under the MIT License. For details, please refer to the LICENSE file.

🌐 Community and Support

• GitHub Repository: https://github.com/your-username/shopify-mcp-server
• Issue Reporting: Feel free to submit bugs or feature requests in the Issues section.
• Documentation Contribution: Welcome to contribute to the project documentation.

🔗 Links

• Shopify Development Documentation
• Model Context Protocol (MCP)