Shopify MCP Server

Shopify MCP Server

site icon
2025.03.27 0
TypeScript订单管理电商集成金融服务
Shopify MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于将 Shopify 操作与 LLM 代理集成。该服务器提供了一套工具,用于处理 Shopify 订单,包括履行、跟踪、归档和检索。
View on GitHub

Overview

基本能力

产品定位

Shopify MCP Server 是一个用于 Shopify 订单管理的中间件服务,通过 MCP 协议与 LLM 代理集成,提供订单管理的自动化能力。

核心功能

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

适用场景

  • 电商平台的订单自动化管理
  • 与 LLM 代理集成的 Shopify 订单处理系统
  • 需要自动化订单履行和跟踪的 Shopify 商店

工具列表

  • get-order-details: 获取特定订单的详细信息(接受友好订单号如 "#1001")
  • get-active-orders: 获取所有活动订单的列表
  • request-fulfillment: 履行订单并可选添加跟踪信息(接受友好订单号)
  • add-tracking: 向已履行的订单添加跟踪信息
  • archive-order: 归档订单(接受友好订单号)

常见问题解答

  • API 版本管理: 服务器使用 Shopify 的 LATEST_API_VERSION 常量(当前为 2025-01)以确保与新 API 功能的兼容性。
  • PII 处理: 服务器避免请求个人身份信息(PII),如客户详细信息、电子邮件和地址,这些信息在 Shopify 的高级计划中受到限制。

使用教程

使用依赖

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

安装教程

  1. 克隆仓库: bash git clone https://github.com/yourusername/shopify-mcp-server.git cd shopify-mcp-server

  2. 安装依赖: bash npm install

  3. 创建 .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. 构建项目: bash npm run build

  2. 启动服务器: bash npm start

  3. 开发模式(自动重建): bash npm run dev

调试方式

  1. 使用 get-order-details 工具获取订单详细信息: { "orderNumber": "#1001" }

  2. 使用 add-tracking 工具添加跟踪信息: { "fulfillmentId": "gid://shopify/Fulfillment/123456789", "trackingNumber": "1Z999AA10123456789", "trackingCompany": "UPS", "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA10123456789", "notifyCustomer": true }

许可证

该项目遵循 ISC 开源许可条款,请参阅 ISC 了解完整条款。