Shopify MCP Server

项目简介

Shopify MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在连接大型语言模型 (LLM) 客户端与 Shopify 商铺数据。通过此服务器,LLM 可以调用工具来检索商品和客户信息,从而增强其在电商领域的应用能力。

主要功能点

  • 商品信息检索工具 (get-product-list): 允许 LLM 获取 Shopify 商铺中的商品列表,支持通过 'limit' 参数控制返回商品数量。
  • 客户信息检索工具 (get-customer-list): 允许 LLM 获取 Shopify 商铺中的客户列表,同样支持 'limit' 参数控制返回客户数量。
  • 基于 MCP 协议: 采用标准化的 MCP 协议与 LLM 客户端通信,确保兼容性和互操作性。
  • 使用 Stdio 传输协议: 通过标准输入输出流 (Stdio) 与客户端进行数据交换。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/siddhantbajaj/shopify-mcp-server.git
    cd shopify-mcp-server
  2. 创建并激活虚拟环境:
    uv venv
    source .venv/bin/activate   # Unix/MacOS
    .venv\Scripts\activate  # Windows
  3. 安装项目依赖:
    uv pip install -e .

服务器配置

MCP 客户端需要配置以下 JSON 以连接到 Shopify MCP Server。请注意,'command' 和 'args' 指定了启动服务器的命令。

{
  "serverName": "shopify",
  "command": "python",
  "args": ["-m", "shopify_mcp_server.server"]
}

配置参数说明:

  • 'serverName': 服务器名称,这里设置为 "shopify"。
  • 'command': 启动服务器的命令,这里使用 'python' 解释器。
  • 'args': 传递给 'python' 命令的参数,'-m shopify_mcp_server.server' 表示运行 'shopify_mcp_server' 包中的 'server.py' 模块,即启动 MCP 服务器。

Shopify API 凭据配置: 在项目根目录下创建 '.env' 文件,并填入您的 Shopify API 凭据。请替换以下占位符为您实际的 Shopify API 信息。

SHOPIFY_SHOP_URL="your-store.myshopify.com"
SHOPIFY_API_KEY="your_api_key"
SHOPIFY_PASSWORD="your_api_password"
SHOPIFY_ACCESS_TOKEN="your_access_token"

请务必保管好您的 Shopify API 凭据,避免泄露。

基本使用方法

  1. 启动 MCP 服务器: 在项目根目录下运行以下命令启动 Shopify MCP Server:

    python -m shopify_mcp_server.server

    服务器启动后,将监听来自 MCP 客户端的请求。

  2. 配置 MCP 客户端: 在您的 MCP 客户端中,配置上述提供的服务器连接信息。客户端将通过 Stdio 与服务器建立连接,并可以调用 'get-product-list' 和 'get-customer-list' 工具来获取 Shopify 数据。

  3. 调用工具示例 (MCP 客户端发起请求): 客户端可以发送 JSON-RPC 请求来调用工具。例如,调用 'get-product-list' 工具并限制返回 5 个商品的产品信息请求可能如下所示 (具体请求格式取决于 MCP 客户端的实现):

    {
      "jsonrpc": "2.0",
      "method": "call_tool",
      "params": {
        "name": "get-product-list",
        "arguments": {
          "limit": 5
        }
      },
      "id": 1
    }

    服务器将处理请求,调用 Shopify API 获取商品数据,并将结果以 MCP 响应格式返回给客户端。

信息

分类

商业系统