Shopify Storefront MCP Server

🚀 Shopify Store Guide

This guide details how to interact with a Shopify store using the MCP (Multi-Channel Platform) server. It covers a range of topics, including a feature overview, setup instructions, environment variable configuration, steps for generating Storefront API tokens, usage examples, customer resource management, and data privacy and storage strategies.

✨ Features

• Product Information Query: Retrieve all products and their detailed information.
• Shopping Cart Management: Add, modify, and remove items from the shopping cart.
• Order Operations: Create new orders or check the status of existing orders.
• Inventory Synchronization: Keep local inventory consistent with the Shopify store.
• Price Rule Application: Apply promotional activities and pricing strategies.

📦 Installation

Install Dependencies

Use the following command to install the required packages:

npm install shopify-api

Configure Environment Variables

Edit the .env file and add the following configuration:

SHOPIFY_STORE_NAME=your-store.myshopify.com
SHOPIFY_API_KEY=your_api_key
SHOPIFY_API_SECRET=your_api_secret

Initialize the Database

Run the following command to create local database tables:

npx knex migrate:latest

💻 Usage Examples

Basic Usage

Query Product Information

Use the following GraphQL query to get all products:

query {
  products(first: 10) {
    edges {
      node {
        id
        title
        description
        price
      }
    }
  }
}

Create a Shopping Cart

Call the following REST API to create a new shopping cart:

POST /api/2025-04/graphql.json
{
  "query": "mutation createCart($lines: [CartLineInput!]!) {
    cartCreate(input: { lines: $lines }) {
      cart {
        id
        checkoutUrl
      }
      userErrors {
        field
        message
      }
    }
  }",
  "variables": {
    "lines": [
      {
        "merchandiseId": "gid://shopify/ProductVariant/12345678901234",
        "quantity": 1
      }
    ]
  }
}

Apply a Coupon

Use the following mutation to apply a specified coupon:

mutation applyCoupon($cartId: ID!, $couponCode: String!) {
  cartUpdate(id: $cartId, updates: { couponCode: $couponCode }) {
    cart {
      id
      totalAmount
    }
    userErrors {
      field
      message
    }
  }
}

📚 Customer Resource Management

Data Structure

Customer data is stored in the db/customers.json file, which includes the following fields:

Data Operations

Add a New Customer

const newCustomer = {
  id: generateUUID(),
  firstName: "John",
  lastName: "Doe",
  email: "john.doe@example.com",
  address: "123 Main St, City"
};
db.customers.push(newCustomer);

Update an Existing Customer

const customer = db.customers.find(c => c.id === customerId);
if (customer) {
  customer.firstName = "Jane";
  customer.lastName = "Smith";
}

📄 Data Privacy and Storage

File Management

• Data File: db/customers.json
• Example File: db/customers.json.example provides a template with fictional customer data.

Security Measures

1. Do not commit sensitive files such as .env and db/customers.json to the version control system.
2. Use encryption technology to protect customers' personal information.
3. Regularly back up the database to prevent data loss.

🔧 Troubleshooting

Problem: Unable to Connect to the Shopify Store

Solution:

1. Check the network connection.
2. Ensure that the API key and secret are correct.
3. Refer to Shopify's developer documentation for more help.

Problem: Shopping Cart Creation Failed

Solution:

1. Validate that the passed parameters meet the requirements.
2. Confirm that the products exist and have sufficient stock.
3. Check the log files for detailed error information.

Summary

This guide provides basic methods for interacting with a Shopify store, covering aspects from data query to customer management. By following these steps and best practices, you can effectively integrate and manage your Shopify store.