Shopify MCP Server 使用说明

项目简介

本仓库实现了一个基于 Model Context Protocol (MCP) 的服务器，旨在将 Shopify API 的功能集成到 LLM 应用中。通过 MCP 协议，该服务器为 AI Agent 提供了标准化接口，使其能够安全、便捷地访问和操作 Shopify 店铺的商品、订单等数据。该服务器提供了工具 (Tools)、资源 (Resources) 和 Prompt 模板 (Prompts) 三种核心 MCP 功能，帮助开发者快速构建基于 Shopify 数据的 LLM 应用。

主要功能点

Shopify API 集成: 深度集成 Shopify GraphQL API，支持商品和订单数据的访问和操作。
MCP 协议兼容: 完全遵循 Model Context Protocol 标准，确保与 MCP 客户端的无缝对接。
工具 (Tools): 提供 'list_products' 和 'list_orders' 工具，允许 AI Agent 查询商品和订单列表，并支持参数过滤和排序。
资源 (Resources): 提供 'shopify:products' 和 'shopify:orders' 资源，允许 AI Agent 直接访问 JSON 格式的商品和订单数据。
Prompt 模板 (Prompts): 内置 'shopify_usage' 和 'shopify_troubleshooting' Prompt，为用户提供使用指南和问题排查帮助。

安装步骤

安装 Node.js 和 npm: 确保你的开发环境已安装 Node.js 和 npm 包管理器。
克隆仓库: 使用 'git clone https://github.com/sarayd/shopify-mcp-server' 命令克隆代码仓库到本地。
进入目录: 使用 'cd shopify-mcp-server' 命令进入项目目录。
安装依赖: 运行 'npm install' 命令安装项目所需的依赖包。

配置环境变量: 在项目根目录下创建 '.env' 文件，并填入你的 Shopify 店铺名称和私有应用访问令牌：

SHOPIFY_SHOP_NAME=your-shop-name  # 替换为你的 Shopify 店铺名称，例如：your-store.myshopify.com 中的 your-store
SHOPIFY_ACCESS_TOKEN=your-access-token # 替换为你的 Shopify 私有应用访问令牌

请务必替换 'your-shop-name' 和 'your-access-token' 为你真实的 Shopify 店铺信息。

构建项目: 运行 'npm run build' 命令编译 TypeScript 代码。

服务器配置

MCP 客户端需要配置以下 JSON 信息以启动并连接到 Shopify MCP Server：

{
  "serverName": "shopify-mcp-server",
  "command": "npm",
  "args": ["start"]
}

配置参数说明：

'serverName': MCP 服务器的名称，可以自定义，例如 "shopify-mcp-server"。
'command': 启动服务器的命令，这里使用 'npm'，因为项目使用 npm 脚本管理。
'args': 命令的参数，'["start"]' 表示执行 'npm start' 脚本，该脚本在 'package.json' 中定义，用于启动服务器。

基本使用方法

启动服务器: 在 MCP 客户端中配置上述 JSON 信息后，启动 Shopify MCP Server。服务器成功启动后，会在终端输出 'Shopify MCP Server is running at http://localhost:3000/mcp' 提示，表示服务器已在本地 3000 端口的 '/mcp' 路径上运行。
连接 MCP 客户端: 在你的 MCP 客户端（如 Claude 桌面客户端）中，配置连接到 'http://localhost:3000/mcp' 这个地址。
使用工具和资源: 连接成功后，你可以在 MCP 客户端中使用以下工具和资源与 Shopify 店铺进行交互：
- 工具 (Tools):
  - 'list_products': 列出商品，可以通过 'query' 参数进行搜索，'first' 参数限制返回数量，'reverse' 参数反转排序。
  - 'list_orders': 列出订单，参数与 'list_products' 类似。
- 资源 (Resources):
  - 'shopify:products': 直接访问商品数据，返回 JSON 格式的商品列表。
  - 'shopify:orders': 直接访问订单数据，返回 JSON 格式的订单列表。
参考 Prompt: 使用 'shopify_usage' 和 'shopify_troubleshooting' Prompt 获取更详细的使用指导和问题排查信息。

通过以上步骤，你就可以利用 Shopify MCP Server 在 LLM 应用中集成 Shopify 的数据和功能了。

关键词