Shopify MCP Server Main

🚀 Shopify MCP Server

This project provides a MCP (Model Context Protocol) server for Shopify, enabling seamless interaction with Shopify stores by connecting different services and systems.

🚀 Quick Start

Create a Shopify Application

1. Log in to the Shopify Partners website and register a developer account.
2. Create a new application in the console and fill in the necessary application information (e.g., name, description).
3. Configure the application's callback URL and permission scope.

Clone the MCP Server Code

Use the Git command to clone this repository:

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

Install Dependencies

After entering the project directory, install the required dependency packages:

npm install

Configure Environment Variables

Create a .env file and add the following content:

SHOPIFY_API_KEY=your_api_key
SHOPIFY_API_SECRET=your_api_secret
PORT=3000

Start the Server

Run the following command to start the MCP server:

node index.js

By default, the server will run on http://localhost:3000.

✨ Features

Core Functions

• Product Management: Supports reading and writing product data.
• Customer Management: Allows operations on customer profile information.
• Order Processing: Provides CRUD (Create, Read, Update, Delete) operations on orders.
• Favorite Management: Manages the products customers have favorited.
• Webhook Integration: Subscribes to or unsubscribes from Shopify's webhook events.

Tool List

The following are the main functional modules provided by the server and their detailed descriptions:

1. Get Products (get-products):

   • Input Parameters: searchTitle (product title for searching), limit (limits the number of returned products).
   • Output Results: Contains information such as product ID, title, description, and price.

2. Create Product (create-product):

   • Input Parameters: title (product title), description (product description), price (product price), etc.
   • Returns the ID of the newly created product.

3. Update Product (update-product):

   • Requires providing the product ID and the fields to be modified, such as newTitle or newDescription.

4. Delete Product (delete-product):

   • Input Parameter: productId (the unique identifier of the product to be deleted).
   • Returns a confirmation message indicating successful deletion.

5. Get Customers (get-customers):

   • Supports filtering customer data by email. By default, it returns the basic information of all customers.

6. Create Customer (create-customer):

   • Input Parameters: email, firstName, lastName, etc.
   • Returns the unique identifier of the new customer.

7. Update Customer (update-customer):

   • Requires providing the customer ID and the fields to be modified, such as newEmail or newFirstName.

8. Delete Customer (delete-customer):

   • Input Parameter: customerId (the unique identifier of the customer to be deleted).
   • Returns a confirmation message indicating successful deletion.

9. Get Orders (get-orders):

   • Supports filtering order data by time range or other filtering conditions.

10. Create Order (create-order):

    • Requires providing parameters such as the customer ID and product information.
    • Returns the newly generated order number.

11. Update Order (update-order):

    • Input Parameters: orderId (the unique identifier of the order to be modified), newStatus (the new order status), etc.

12. Delete Order (delete-order):

    • Input Parameter: orderId.
    • Returns a confirmation message indicating successful deletion.

13. Get Collections (get-collections):

    • Supports filtering collection data by name or other filtering conditions.

14. Create Collection (create-collection):

    • Requires providing the name of the collection and other relevant information.
    • Returns the ID of the newly created collection.

15. Update Collection (update-collection):

    • Input Parameters: collectionId (the unique identifier of the collection to be modified), newName (the new name of the collection), etc.

16. Delete Collection (delete-collection):

    • Input Parameter: collectionId.
    • Returns a confirmation message indicating successful deletion.

17. Subscribe to Webhook (subscribe-webhook):

    • Requires providing the target URL and the event types to subscribe to (e.g., order creation, product update).
    • Returns a confirmation message indicating successful subscription.

18. Unsubscribe from Webhook (unsubscribe-webhook):

    • Input Parameter: subscriptionId (the unique identifier of the subscription to be cancelled).
    • Returns a confirmation message indicating successful cancellation.

💻 Usage Examples

Basic Usage

const request = require('request');

// Get the product list
request.get('http://localhost:3000/api/products', { json: true }, (err, res, body) => {
  if (!err && res.statusCode === 200) {
    console.log(body.data);
  }
});

// Create a new customer
const options = {
  method: 'POST',
  url: 'http://localhost:3000/api/customers',
  json: {
    email: 'test@example.com',
    firstName: 'John',
    lastName: 'Doe'
  }
};

request(options, (error, response, body) => {
  if (!error && response.statusCode === 201) {
    console.log('Customer created successfully!');
  }
});

Advanced Usage

// Batch get products
server.post('/api/products/batch', (req, res) => {
  const { products } = req.body;
  // Processing logic
});

// Batch delete customers
server.delete('/api/customers/batch', (req, res) => {
  const { customerIds } = req.body;
  // Processing logic
});

🔧 Technical Details

Database Selection

The server uses MongoDB as the default database and can also support other storage systems through configuration.

Security Mechanisms

• Authentication: All API endpoints require a valid authentication token.
• Rate Limiting: To prevent abuse, the server has a built - in rate - limiting function.
• Request Encryption: Sensitive operations require encrypted transmission via HTTPS.

Event - Driven Architecture

Based on Node.js's asynchronous event - handling model, the server can efficiently handle a large number of concurrent requests.

🤝 Contribution Guidelines

If you are interested in this project, you are welcome to join our development team. You can contribute code in the following ways:

1. Fork this repository.
2. Create a new branch for modifications.
3. Commit and push your changes.
4. Submit a Pull Request to the main repository. Please ensure that your submissions follow the code specifications and provide detailed documentation.

📄 License

This project is licensed under the MIT License. For specific terms, see the LICENSE file.