Shopify MCP Server

Shopify MCP 服务

用于将 Shopify 操作与大模型 Agent 集成的模型上下文协议（MCP）服务。此服务提供了一组用于处理 Shopify 订单的工具，包括履行订单、跟踪、归档和检索。

功能

• 请求履行订单
• 为订单添加跟踪信息
• 归档订单
• 获取特定订单的详细信息
• 列出所有有效订单

设置

前提条件

• Node.js 18 或更高版本
• 具有 API 访问权限的 Shopify 商店

安装

1. 克隆仓库：

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

2. 安装依赖：

   npm install
   

3. 根据 .env.example 创建 .env 文件，并添加 Shopify API 凭据：

   SHOPIFY_API_KEY=your_api_key
   SHOPIFY_API_SECRET=your_api_secret
   SHOPIFY_SCOPES=write_orders,read_orders
   SHOPIFY_SHOP=your-shop.myshopify.com
   SHOPIFY_ACCESS_TOKEN=your_access_token
   

构建和运行

1. 构建项目：

   npm run build
   

2. 启动服务：

   npm start
   

3. 在开发过程中自动重新构建：

   npm run dev
   

与大模型 Agent 配合使用

此服务实现了模型上下文协议（MCP），并提供以下工具：

• get-order-details：获取特定订单的详细信息（接受类似 "#1001" 的易读订单编号）
• get-active-orders：获取所有有效订单的列表
• request-fulfillment：履行订单，可选填写跟踪信息（接受易读订单编号）
• add-tracking：为已履行的订单添加跟踪信息
• archive-order：归档订单（接受易读订单编号）

使用易读订单编号

现在，所有需要订单 ID 的工具都接受易读订单编号：

• #1001 - 带 # 前缀的订单编号
• 1001 - 不带 # 前缀的订单编号
• 完整的 Shopify ID（gid://shopify/Order/12345）- 仍受支持

当你提供易读订单编号时，系统会自动查找对应的 Shopify ID。

更新跟踪信息

要更新订单的跟踪信息，请按以下步骤操作：

1. 首先，使用订单编号（例如 #1001）调用 get-order-details 获取订单详情
2. 在响应的“履行记录”部分找到履行 ID
3. 使用 add-tracking 工具和履行 ID 及跟踪信息：

   {
     "fulfillmentId": "gid://shopify/Fulfillment/123456789",
     "trackingNumber": "1Z999AA10123456789",
     "trackingCompany": "UPS",
     "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA10123456789",
     "notifyCustomer": true
   }
   

技术详情

API 版本管理

此服务使用 Shopify 的 LATEST_API_VERSION 常量（目前为 2025-01），以确保兼容最新的 API 功能。这种做法有助于让应用面向未来，但 Shopify 对其 API 进行不兼容变更时，可能偶尔需要调整架构。

PII 处理

为了支持使用所有 Shopify 套餐的商店，此服务不会请求个人身份信息（PII），例如客户详情、电子邮件和地址，因为这些信息仅对更高级别的 Shopify 套餐开放。

许可证

ISC