Shopify MCP Server 使用说明

项目简介

Shopify MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在帮助大型语言模型 (LLM) 客户端应用便捷地访问和操作 Shopify 电商平台的数据。通过提供标准化的 MCP 接口，该服务器允许 LLM 应用调用各种工具来查询商品信息、管理客户数据、处理订单以及创建和管理促销折扣等，从而实现更智能的电商应用场景。

主要功能点

商品管理: 支持检索商品信息，包括商品列表、按ID或集合ID查找商品。
订单管理: 支持高级订单查询和筛选，以及获取单个订单详情。
客户管理: 支持加载客户数据和管理客户标签。
折扣管理: 支持创建基础折扣码。
草稿订单: 支持创建和完成草稿订单。
集合管理: 支持获取商品集合信息。
店铺信息: 支持获取店铺的基本和详细信息。
Webhook管理: 支持订阅、查找和取消订阅 Webhook 事件。

安装步骤

克隆仓库

git clone https://github.com/amir-bengherbi/shopify-mcp-server.git
cd shopify-mcp-server

安装依赖 确保已安装 Node.js 和 npm，然后运行：
```
npm install
```
配置 Shopify Access Token 和域名
- 前往您的 Shopify 后台，创建一个自定义应用并获取 Admin API access token (具体步骤请参考仓库 README.md 中的 "Setup" 部分)。
- 创建 '.env' 文件，并填入您的 Shopify Access Token 和店铺域名：
```
SHOPIFY_ACCESS_TOKEN=您的_Access_Token
MYSHOPIFY_DOMAIN=您的店铺域名.myshopify.com
```
  注意: 请务必妥善保管您的 Access Token，避免泄露。
构建项目
```
npm run build
```

服务器配置

对于 MCP 客户端 (例如 Claude Desktop)，您需要在其配置文件 'claude_desktop_config.json' 中添加 Shopify MCP Server 的配置信息。以下是一个示例配置，请根据您的实际情况进行调整：

{
  "mcpServers": {
    "shopify": {  // 服务器名称，可以自定义
      "command": "npx", // 启动命令，这里使用 npx 运行 npm 包
      "args": ["-y", "shopify-mcp-server"], // 启动参数，-y 表示自动确认安装，shopify-mcp-server 是package.json中配置的bin命令，指向dist/index.js
      "env": { // 环境变量配置
        "SHOPIFY_ACCESS_TOKEN": "<YOUR_ACCESS_TOKEN>", // 替换为您的 Shopify Access Token
        "MYSHOPIFY_DOMAIN": "<YOUR_SHOP>.myshopify.com" // 替换为您的 Shopify 店铺域名
      }
    }
  }
}

配置参数说明:

'server name': 自定义服务器名称，用于在客户端中标识和调用。例如 "shopify"。
'command': 启动服务器的命令。通常为 'node' 或 'npx'，根据项目的启动方式而定。
'args': 传递给启动命令的参数。例如 '["dist/index.js"]' 指定服务器入口文件，或者 '["-y", "shopify-mcp-server"]' 使用 'npx' 运行 npm 包。
'env': 环境变量配置。用于传递服务器运行所需的敏感信息或配置参数，例如 Shopify Access Token 和店铺域名。

基本使用方法

配置完成后，您的 MCP 客户端 (如 Claude Desktop) 应该能够连接到 Shopify MCP Server。您可以通过客户端提供的界面或指令，调用服务器提供的各种工具来访问和操作 Shopify 数据。

例如，您可以使用 'get-products' 工具来检索商品信息，或者使用 'get-orders' 工具来查询订单列表。具体可用的工具及其参数请参考仓库 README.md 中的 "Tools" 部分。

示例工具调用 (假设在 Claude Desktop 中):

获取商品列表: 调用 'shopify.get-products' 工具，可以设置 'limit' 参数限制返回商品数量。
创建折扣码: 调用 'shopify.create-discount' 工具，并提供折扣码的标题、代码、折扣值等参数。

请参考仓库的 README.md 文件了解更多关于可用工具、输入参数和返回结果的详细信息。

关键词