使用说明

项目简介

Clover MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 客户端（如 Claude）提供访问 Clover 商户数据的能力。通过此服务器，LLM 可以安全、便捷地获取 Clover 平台的商品、订单及商户信息，从而扩展 LLM 在电商和零售领域的应用场景。

主要功能点

资源访问: 支持读取 Clover 商品 ('clover_item') 和订单 ('clover_order') 资源。
工具调用: 提供 'list_inventory' (列出商品)、'list_orders' (列出订单)、'get_merchant_info' (获取商户信息)、'initiate_oauth_flow' (OAuth 授权) 和 'get_oauth_status' (OAuth 状态查询) 等工具。
OAuth 认证: 采用 OAuth 2.0 协议进行身份验证，确保数据访问安全。

安装步骤

确保已安装 Node.js 和 npm。

克隆仓库到本地：

git clone https://github.com/ibraheem4/clover-mcp.git

进入项目目录：
```
cd clover-mcp
```
安装依赖：
```
npm install
```

复制 '.env.example' 文件并重命名为 '.env'：

cp .env.example .env

编辑 '.env' 文件，填入你的 Clover 应用的 'CLOVER_CLIENT_ID' 和 'CLOVER_CLIENT_SECRET'，以及 Clover API 的 'BASE_URL' (默认为沙箱环境 'https://apisandbox.dev.clover.com')。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Clover MCP 服务器。请注意，以下配置信息不是代码，而是 MCP 客户端（如 Claude）的配置文件内容。

{
  "mcpServers": {
    "clover": {
      "command": "npx",
      "args": ["@ibraheem4/clover-mcp"],
      "env": {
        "CLOVER_CLIENT_ID": "your-clover-client-id",
        "CLOVER_CLIENT_SECRET": "your-clover-client-secret",
        "CLOVER_BASE_URL": "https://apisandbox.dev.clover.com"
      },
      "disabled": false,
      "autoApprove": ["initiate_oauth_flow", "get_merchant_info", "list_inventory", "list_orders"]
    }
  }
}

配置参数说明:

'"server name"': 服务器名称，这里是 '"clover"'，可以自定义。
'"command"': 启动服务器的命令，这里使用 'npx' 直接运行 npm 包。
'"args"': 传递给启动命令的参数，这里是 npm 包名 '"@ibraheem4/clover-mcp"'。
'"env"': 环境变量配置，用于传递 Clover API 的密钥等敏感信息。
- '"CLOVER_CLIENT_ID"': 你的 Clover 应用的客户端 ID，请替换为实际值。
- '"CLOVER_CLIENT_SECRET"': 你的 Clover 应用的客户端密钥，请替换为实际值。
- '"CLOVER_BASE_URL"': Clover API 的基础 URL，默认为沙箱环境。
'"disabled"': 是否禁用该服务器，'false' 表示启用。
'"autoApprove"': 自动批准的工具列表，客户端在调用这些工具时无需用户额外确认。

基本使用方法

在 MCP 客户端（如 Claude）中配置上述服务器配置信息。
在客户端中启用 Clover MCP 服务器 (例如在 Claude 中使用 '/mcp use clover')。
使用自然语言指令与客户端交互，例如：
- 'Can you help me connect to my Clover account?' (触发 OAuth 授权流程)
- 'What information do you have about my Clover merchant account?' (获取商户信息)
- 'Show me the first 10 items in my inventory.' (列出商品)
- 'Can you list my most recent orders?' (列出订单)

关键词