使用说明
项目简介
Shopify MCP Server 是一个专门为 Shopify 电商平台设计的 MCP 服务器,它允许大型语言模型(LLM)客户端通过标准化的 MCP 协议与 Shopify API 进行交互。该服务器提供了一系列工具,使得 LLM 能够轻松访问和操作 Shopify 商店的数据,例如商品、客户、订单、折扣码和网络钩子等。
主要功能点
- 商品管理:检索商品信息,包括按标题搜索、按 Collection ID 和 Product IDs 获取商品,以及获取商品变体信息。
- 客户管理:加载客户数据,并支持为客户添加标签。
- 订单管理:提供高级订单查询和过滤功能,可以按 ID 获取订单,创建草稿订单和完成草稿订单。
- 店铺信息:获取店铺的基本信息和详细信息,包括支持的运送国家/地区。
- 折扣码管理:创建基本的折扣码。
- 网络钩子管理:订阅、查找和取消订阅 Shopify 网络钩子,以便实时获取店铺事件通知。
- GraphQL API 集成:直接与 Shopify 的 GraphQL Admin API 集成,保证数据访问的效率和准确性。
- 完善的错误处理:针对 API 和身份验证问题提供清晰的错误消息,方便开发者调试和排错。
安装步骤
-
克隆仓库
git clone https://github.com/rezapex/shopify-mcp-server-main.git cd shopify-mcp-server-main -
安装依赖
npm install -
配置环境变量 在项目根目录下创建 '.env' 文件,并填入您的 Shopify API 密钥和店铺域名:
SHOPIFY_ACCESS_TOKEN=您的_Shopify_Access_Token MYSHOPIFY_DOMAIN=您的店铺域名.myshopify.com注意:
- 'SHOPIFY_ACCESS_TOKEN' 需要您在 Shopify 后台创建自定义应用后获取。请参考 Shopify Access Token 获取指南 获取详细步骤。
- 'MYSHOPIFY_DOMAIN' 是您的 Shopify 店铺域名,例如 'your-store.myshopify.com'。
-
构建项目
npm run build -
启动服务器
npm start启动成功后,您将在控制台看到 "Shopify MCP Server running on stdio" 和 "Connected to shop: 您的店铺域名.myshopify.com" 的信息。
服务器配置
为了让 MCP 客户端(如 Claude Desktop)连接到 Shopify MCP Server,您需要在客户端的配置文件中添加服务器配置信息。以 'claude_desktop_config.json' 为例,配置信息如下:
{ "mcpServers": { "shopify": { // 服务器名称,可以自定义 "command": "npx", // 启动服务器的命令,这里使用 npx 运行 npm 包 "args": ["-y", "shopify-mcp-server"], // 传递给 command 的参数,-y 用于跳过 npm 包安装确认 "env": { // 环境变量配置 "SHOPIFY_ACCESS_TOKEN": "<YOUR_ACCESS_TOKEN>", // 替换为您的 Shopify Access Token "MYSHOPIFY_DOMAIN": "<YOUR_SHOP>.myshopify.com" // 替换为您的 Shopify 店铺域名 } } } }
配置参数说明:
- 'server name': 'shopify' (用户可以自定义服务器名称,用于在客户端中引用)
- 'command': 'npx' (通常使用 npx 来运行本地 npm 包)
- 'args': '["-y", "shopify-mcp-server"]' (指定要运行的 npm 包名称,'-y' 参数可选,用于自动确认 npm 包安装)
- 'env': 包含服务器运行所需的环境变量
- 'SHOPIFY_ACCESS_TOKEN': Shopify API 访问令牌,务必替换为您的真实 Access Token
- 'MYSHOPIFY_DOMAIN': Shopify 店铺域名,务必替换为您的真实店铺域名
Shopify Access Token 获取指南
- 登录您的 Shopify 管理后台。
- 点击 设置 (Settings) > 应用和销售渠道 (Apps and sales channels)。
- 点击 开发应用 (Develop apps)。如果您是首次使用,可能需要先启用开发者预览。
- 点击 创建应用 (Create app)。
- 为您的应用设置名称,例如 "Shopify MCP Server"。
- 点击 配置 Admin API 范围 (Configure Admin API scopes)。
- 选择以下权限范围(根据您的实际需求选择,以下为示例中工具可能需要的权限):
- 'read_products', 'write_products' (商品读写权限)
- 'read_customers', 'write_customers' (客户读写权限)
- 'read_orders', 'write_orders' (订单读写权限)
- 'read_discounts', 'write_discounts' (折扣码读写权限)
- 'read_themes', 'write_themes' (主题读写权限,如果需要管理主题相关的功能)
- 'read_content', 'write_content' (内容读写权限,如果需要管理博客文章或页面等内容)
- 'read_inventory', 'write_inventory' (库存读写权限)
- 'read_locations' (店铺地点读取权限)
- 'unauthenticated_read_content' (非认证内容读取权限,例如公开的店铺信息)
- 'webhook' (网络钩子权限)
- 点击 保存 (Save)。
- 点击 安装应用 (Install app)。
- 点击 安装 (Install) 以授权应用访问您的店铺数据。
- 安装完成后,您将看到 Admin API 访问令牌 (Admin API access token)。
- 复制 这个令牌,并将其填写到 '.env' 文件和 'claude_desktop_config.json' 配置文件中。
安全提示:请务必妥善保管您的 Access Token,避免泄露或提交到版本控制系统。
基本使用方法
Shopify MCP Server 启动后,MCP 客户端(如 Claude Desktop)即可通过配置的服务器名称 "shopify" 调用该服务器提供的工具。具体的工具调用方式取决于 MCP 客户端的功能和界面。
例如,在 Claude Desktop 中,您可以使用 '@shopify' 前缀来调用 Shopify MCP Server 提供的工具,例如:
- '@shopify get-products searchTitle="T-Shirt"' 搜索标题包含 "T-Shirt" 的商品
- '@shopify get-customers limit=10' 获取 10 个客户信息
- '@shopify get-orders first=5 query="financial_status:paid"' 获取前 5 个已支付的订单
更多工具的具体用法,请参考仓库 'README.md' 文件中 Tools 部分的详细描述,其中包含了每个工具的名称、描述、输入参数和返回值说明。
信息
分类
商业系统