🚀 Shopify MCP 服务器
这是一个用于将 Shopify 运营与 LLM 代理集成的 Model Context Protocol (MCP) 服务器。该服务器提供了一系列工具，可用于处理 Shopify 订单，涵盖履行订单、添加跟踪信息、存档以及检索订单等操作，极大地提升了 Shopify 订单管理的效率和便捷性。
✨ 主要特性
- 可请求订单履行，确保订单流程顺利推进。
- 支持添加订单跟踪信息，方便实时掌握订单物流状态。
- 能够存档订单，有效管理订单数据。
- 可获取特定订单的详细信息，满足精准查询需求。
- 能列出所有活跃订单，便于整体把控订单情况。
📦 安装指南
安装前准备
- 需要 Node.js 18 或更高版本。
- 要有具有 API 访问权限的 Shopify 商店。
安装步骤
- 克隆仓库：
git clone https://github.com/yourusername/shopify-mcp-server.git
cd shopify-mcp-server
- 安装依赖项：
npm install
- 基于
.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
🚀 快速开始
构建和运行
- 构建项目：
npm run build
- 启动服务器：
npm start
- 使用自动重新构建进行开发：
npm run dev
💻 使用示例
与 LLM 代理一起使用
此服务器实现 Model Context Protocol (MCP) 并公开以下工具：
get-order-details：获取特定订单的详细信息（接受带友好编号格式的订单号，如 "#1001"）get-active-orders：获取所有活跃订单的列表request-fulfillment：请求履行订单，可选添加跟踪信息（接受友好订单号）add-tracking：向已履行的订单添加跟踪信息archive：存档一个订单（接受友好订单号）
使用友好的订单号
所有需要订单 ID 的工具现在都支持友好订单号：
#1001- 带有井号前缀的订单号1001- 不带井号前缀的订单号- 完整的 Shopify ID（例如 gid://shopify/Order/12345）- 仍然支持
系统会自动查找正确的 Shopify ID，当您提供友好格式的订单号时。
更新跟踪信息
要更新订单的跟踪信息，请按照以下步骤操作：
- 首先，使用
get-order-details工具获取订单详细信息（例如，使用订单号 "#1001"） - 从响应中，在“履行”部分找到履行 ID
- 使用
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)。所有用户交互均通过匿名化或脱敏数据进行，并且没有任何用户凭据被存储或传递。
📄 许可证
[在此处插入许可证信息]
贡献者
- [在此处列出贡献者]
链接
[在此处添加相关链接，如文档、示例等]