Shopify MCP Server

Shopify MCP Server

site icon
2025.04.20 0
TypeScript电子商务Shopify APIGraphQL产品管理订单管理开发效率金融服务
Shopify MCP Server 是一个用于与 Shopify API 交互的服务器,通过 GraphQL API 管理商店数据。它提供了管理产品、客户、订单等功能,适用于电子商务平台的开发和管理。
View on GitHub

Overview

基本能力

产品定位

Shopify MCP Server 是一个用于与 Shopify API 交互的服务器,通过 GraphQL API 管理商店数据。

核心功能

  • 产品管理:搜索和检索产品信息
  • 客户管理:加载客户数据和管理客户标签
  • 订单管理:高级订单查询和过滤
  • GraphQL 集成:直接与 Shopify 的 GraphQL Admin API 集成
  • 全面的错误处理:清晰的错误消息用于 API 和认证问题

适用场景

  • 管理产品信息
  • 处理客户数据和订单
  • 创建折扣代码和草稿订单
  • 管理 Shopify 商店的 Webhook

工具列表

  1. get-products:获取所有产品或按标题搜索
  2. get-products-by-collection:从特定集合获取产品
  3. get-products-by-ids:按 ID 获取产品
  4. get-variants-by-ids:按 ID 获取产品变体
  5. get-customers:获取 Shopify 客户(支持分页)
  6. tag-customer:为客户添加标签
  7. get-orders:获取订单(支持高级过滤和排序)
  8. get-order:按 ID 获取单个订单
  9. create-discount:创建基本折扣代码
  10. create-draft-order:创建草稿订单
  11. complete-draft-order:完成草稿订单
  12. get-collections:获取所有集合
  13. get-shop:获取商店详情
  14. get-shop-details:获取扩展商店详情(包括运输国家)
  15. manage-webhook:订阅、查找或取消订阅 Webhook

常见问题解答

  • 如何获取 Shopify 访问令牌?
  • 从 Shopify 管理员创建自定义应用并配置 API 范围。
  • 如何测试服务器?
  • 使用 Jest 运行单元测试,测试使用模拟以避免实际 API 调用。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库:
git clone https://github.com/your-username/shopify-mcp-server.git

安装教程

  1. 导航到项目目录:
cd shopify-mcp-server
  1. 安装依赖:
npm install
  1. 创建 .env 文件并添加 Shopify 凭证:
SHOPIFY_ACCESS_TOKEN=your_access_token
MYSHOPIFY_DOMAIN=your-store.myshopify.com
  1. 构建项目:
npm run build
  1. 运行服务器:
npm start

调试方式

  1. 运行测试:
npm test
  1. 生成覆盖率报告:
npm test -- --coverage

许可证

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