项目简介
Shopify MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在通过标准化的方式向 LLM 客户端提供 Shopify 店铺的上下文信息和功能。它集成了 Shopify API,允许用户通过自然语言指令与店铺数据进行交互。
主要功能点
- 产品管理:检索和管理 Shopify 产品信息,包括搜索产品、按集合获取产品、按ID获取产品等。
- 订单管理:查询、过滤和处理 Shopify 订单,支持高级过滤和排序,以及创建草稿订单和完成订单等操作。
- 客户管理:获取和管理 Shopify 客户数据,包括获取客户列表和为客户添加标签。
- 折扣管理:创建和管理 Shopify 折扣码。
- Webhook 管理:订阅和管理 Shopify Webhook,支持订阅、查找和取消订阅 Webhook。
- 店铺信息:获取店铺基本信息和详细信息,包括支持的发货国家/地区。
- GraphQL API 集成:直接与 Shopify GraphQL Admin API 交互,保证数据操作的高效性。
安装步骤
-
克隆仓库 在你的本地计算机上克隆 GitHub 仓库:
git clone https://github.com/rezapex/shopify-mcp-server-main.git -
进入项目目录
cd shopify-mcp-server-main -
安装依赖 使用 npm 安装项目依赖:
npm install -
配置环境变量 在项目根目录下创建 '.env' 文件,并配置你的 Shopify API 访问令牌和店铺域名:
SHOPIFY_ACCESS_TOKEN=your_access_token MYSHOPIFY_DOMAIN=your-store.myshopify.com请将 'your_access_token' 替换为你的 Shopify Admin API 访问令牌,'your-store.myshopify.com' 替换为你的 Shopify 店铺域名。
-
构建项目 运行构建命令编译 TypeScript 代码:
npm run build
服务器配置
对于 MCP 客户端,你需要在其配置文件中添加 Shopify MCP Server 的相关信息。以下是一个 'claude_desktop_config.json' 示例配置,展示了如何配置 Shopify MCP Server:
{ "mcpServers": { "shopify": { "command": "npx", "args": ["-y", "shopify-mcp-server"], "env": { "SHOPIFY_ACCESS_TOKEN": "<YOUR_ACCESS_TOKEN>", // 替换为你的 Shopify API 访问令牌 "MYSHOPIFY_DOMAIN": "<YOUR_SHOP>.myshopify.com" // 替换为你的 Shopify 店铺域名 } } } }
配置参数说明:
- 'server name': 'shopify' (服务器名称,客户端用于引用)
- 'command': 'npx' (用于执行 npm 包的命令)
- 'args': '["-y", "shopify-mcp-server"]' (启动服务器的参数,'-y' 自动确认安装 'shopify-mcp-server' 包)
- 'env': 环境变量配置,包含:
- 'SHOPIFY_ACCESS_TOKEN': 你的 Shopify Admin API 访问令牌
- 'MYSHOPIFY_DOMAIN': 你的 Shopify 店铺域名
基本使用方法
启动 Shopify MCP Server 后,MCP 客户端可以通过配置连接到该服务器。客户端可以通过 JSON-RPC 协议调用服务器提供的各种工具,以实现对 Shopify 店铺数据的查询和管理。
例如,你可以使用 'get-products' 工具来获取产品列表,使用 'get-orders' 工具来获取订单信息,或者使用 'tag-customer' 工具为指定客户添加标签。具体的工具名称、输入参数和输出格式可以参考仓库的 'README.md' 文件中 "Tools" 章节的详细说明。
启动服务器: 在项目根目录下,运行以下命令启动 Shopify MCP Server:
npm start
服务器成功启动后,将通过 stdio 监听客户端请求。
信息
分类
商业系统