Rezapex Shopify MCP Server Main

🚀 Shopify MCP Server

The Shopify MCP Server is a tool that enables interaction with Shopify store data via the GraphQL API, offering a wide range of capabilities.

🚀 Quick Start

The Shopify MCP Server allows you to interact with Shopify store data through the GraphQL API. It provides various functions, including product management, customer management, order processing, GraphQL requests, and error handling.

✨ Features

• Product Management: Create, update, and delete products.
• Customer Management: Manage customer information.
• Order Processing: Process and track orders.
• GraphQL Requests: Access the Shopify API using a GraphQL client.
• Error Handling: Comprehensive error handling mechanism.

📦 Installation

Obtain a Shopify Access Token

To use this MCP server, you need to create a custom app and obtain an access token:

1. Log in to your Shopify admin interface.
2. Navigate to Settings > Apps and sales channels.
3. Click Develop apps (you may need to enable developer preview).
4. Click Create an app and set the app name (e.g., "Shopify MCP Server").
5. Configure the Admin API scopes and select the following ranges:
   • read_products, write_products
   • read_customers, write_customers
   • read_orders, write_orders
6. Install the app and obtain the access token.

Use on Claude Desktop

Add the following content to claude_desktop_config.json:

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

💻 Usage Examples

Basic Usage

Here are the tools provided by the server and their detailed descriptions:

1. Get Products

get-products [--searchTitle <SEARCH_TITLE>] [--limit <LIMIT>]

Description: This command is used to retrieve products from a Shopify store. You can use the optional --searchTitle parameter to search for products with a specific title and the --limit parameter to set the maximum number of products to return.

Example:

get-products --searchTitle "apple" --limit 10

2. Create a Product

create-product <PRODUCT_NAME> <DESCRIPTION> <PRICE>

Description: This command is used to create a new Shopify product. You need to provide the product name, description, and price.

Example:

create-product "New iPhone" "Latest model with advanced features." 999.99

3. Update a Product

update-product <PRODUCT_ID> [--setTitle <NEW_TITLE>] [--setDescription <NEW_DESCRIPTION>] [--setPrice <NEW_PRICE>]

Description: This command is used to update a product with a specified ID. You can use the optional --setTitle, --setDescription, and --setPrice parameters to update the product title, description, and price.

Example:

update-product 123 --setTitle "Updated iPhone" --setDescription "Enhanced features released." --setPrice 1099.99

4. Delete a Product

delete-product <PRODUCT_ID>

Description: This command is used to delete a product with a specified ID.

Example:

delete-product 123

📚 Documentation

Development Information

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Create a .env file:

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

4. Build the project:

   npm run build
   

5. Run tests:

   npm test
   

Dependencies

• @modelcontextprotocol/sdk - MCP protocol implementation
• graphql-request - GraphQL client for the Shopify API
• zod - Runtime type validation

🤝 Contribution Guidelines

Contributions are welcome! Please read our Contributing Guidelines first.

📄 License

This project is licensed under the MIT License.

🌐 Community Resources

• MCP GitHub Discussions
• Report an Issue