项目简介

'gr4vy-typescript' 不仅是一个 Gr4vy API 的 Typescript 客户端 SDK，它同时也是一个实现了 Model Context Protocol (MCP) 的服务器。该 MCP 服务器允许兼容 MCP 的 LLM 客户端（如 Claude、Cursor 等）通过标准化的协议发现并调用 Gr4vy SDK 中暴露的各种 API 功能，从而让 LLM 能够与 Gr4vy 支付处理平台进行交互。

主要功能点

Gr4vy API 功能封装: 将 Gr4vy SDK 提供的账户更新、审计日志、买家管理、数字钱包、礼品卡、商户账户、支付方式、支付选项、支付服务、代发款项、退款、交易处理等所有 API 功能，以 MCP 工具的形式提供给 LLM。
LLM 集成桥梁: 作为 LLM 客户端与 Gr4vy API 之间的桥梁，使得 LLM 可以理解并执行与支付处理相关的任务。
标准化交互: 通过 JSON-RPC 协议遵循 MCP 标准进行通信，确保与任何兼容 MCP 的客户端的互操作性。
工具调用: LLM 客户端可以通过调用该服务器暴露的工具，实现查询交易、创建买家、处理支付等 Gr4vy API 操作。

安装步骤

该项目作为 MCP 服务器运行时，需要安装其对应的 npm 包 '@gr4vy/sdk'。您可以使用以下任一包管理器进行安装：

使用 npm:
```
npm add @gr4vy/sdk
```
使用 pnpm:
```
pnpm add @gr4vy/sdk
```
使用 Bun:
```
bun add @gr4vy/sdk
```

使用 Yarn:

yarn add @gr4vy/sdk zod
# 注意：Yarn 不会自动安装 peerDependencies，你需要手动安装 zod

请注意，运行 MCP 服务器需要 Node.js v20 或更高版本。

服务器配置 (针对 LLM 客户端)

要让 MCP 客户端（如 Claude Desktop, Cursor 等）连接到此 MCP 服务器，您需要在客户端的 MCP 配置中添加该服务器的定义。配置通常是一个 JSON 文件（例如 'claude_desktop_config.json' 或 '.cursor/mcp.json'），包含一个 'mcpServers' 字段。

您需要配置服务器的名称 ('server name')，以及启动该服务器进程的命令 ('command') 和参数 ('args')。以下是配置示例结构及其参数说明：

{
  "mcpServers": {
    "Gr4vy": { // 服务器名称，可自定义
      "command": "npx", // 启动命令，这里使用 npx 执行 npm 包中的 mcp 命令
      "args": [
        "-y", "--package", "@gr4vy/sdk", // 确保使用安装的 sdk 包
        "--",
        "mcp", "start", // 启动 MCP 服务器的子命令
        "--bearer-auth", "YOUR_BEARER_TOKEN", // **必需**: 您的 Gr4vy Bearer Token 或私钥路径。用于服务器连接 Gr4vy API 进行认证。请替换为实际值或环境变量引用。
        "--merchant-account-id", "YOUR_MERCHANT_ACCOUNT_ID" // **必需**: 用于此服务器连接的 Gr4vy 商户账户 ID。请替换为实际值或环境变量引用。
        // 您还可以添加其他可选参数，例如：
        // "--port", "8000", // 指定服务器监听的端口 (默认为随机端口)
        // "--host", "127.0.0.1", // 指定服务器监听的主机 (默认为 127.0.0.1)
        // "--server", "sandbox", // 指定 Gr4vy API 环境 (production 或 sandbox)
        // "--id", "your_gr4vy_instance_id", // 指定 Gr4vy 实例 ID，用于 sandbox 环境 URL
        // "--log-level", "info" // 指定日志级别 (info, debug, warn, error)
      ]
    }
  }
}

请根据您的实际环境和需求替换 'command' 和 'args' 中的占位符及可选参数。

基本使用方法

按照上述步骤安装 '@gr4vy/sdk' npm 包。
在您的 MCP 客户端的配置文件中添加 Gr4vy MCP 服务器的配置，确保提供正确的 Bearer Token/私钥路径和商户账户 ID。
启动或重启您的 MCP 客户端，使其加载新的服务器配置。
在 MCP 客户端中，您应该能够发现名为 "Gr4vy" (或其他您配置的名称) 的 MCP 服务器，并能看到其暴露的 Gr4vy API 方法作为可用的工具。
您现在可以通过 MCP 客户端调用这些工具，例如通过自然语言向 LLM 发出指令，让其执行 Gr4vy 相关的操作（如 "列出最近的 10 笔交易", "创建一个新买家" 等），LLM 将通过 MCP 调用此服务器对应的工具来完成任务。

关键词

项目简介

主要功能点

安装步骤

服务器配置 (针对 LLM 客户端)

基本使用方法

信息