项目简介

'beep-sdk' 提供了一个命令行工具（CLI），用于快速搭建一个BEEP支付集成MCP服务器。这个服务器模板旨在让大型语言模型（LLM）代理能够通过标准化的Model Context Protocol (MCP) 接口，与BEEP支付平台进行交互，实现加密货币支付、流式计费和Solana交易签名等功能。它支持HTTP/HTTPS和Stdio两种通信模式，方便与各种LLM客户端（包括Claude Desktop等）集成。

主要功能点

MCP服务器脚手架: 通过CLI工具快速生成完整的MCP服务器项目结构。
多传输协议支持: 支持HTTP/HTTPS用于Web代理，以及Stdio用于桌面应用程序（如Claude Desktop）的通信。
BEEP支付工具集成: 服务器预集成了多种BEEP支付相关的MCP工具，例如：
- 'checkBeepApi': 检查BEEP API的健康状态。
- 'requestAndPurchaseAsset': 请求并购买资产，支持HTTP 402 Payment Required流。
- 'issuePayment': 发起流式支付会话。
- 'startStreaming'/'pauseStreaming'/'stopStreaming': 管理流式支付会话的启动、暂停和停止。
模块化工具定义: 每个支付功能都被定义为一个独立的MCP工具，易于理解和扩展。
TypeScript支持: 项目基于TypeScript构建，提供类型安全和良好的开发体验。

安装步骤

安装BEEP CLI: 打开终端，运行以下命令全局安装BEEP CLI：

npm install -g @beep-it/cli

生成MCP服务器项目: 选择一个目标目录（例如 'my-payment-server'），并选择通信模式。'https' 模式适用于Web代理，'stdio' 模式适用于桌面客户端（如Claude Desktop）。

创建HTTP/HTTPS模式的服务器：

beep init-mcp --role mcp-server --mode https my-payment-server

创建Stdio模式的服务器：

beep init-mcp --role mcp-server --mode stdio my-payment-server

如果您想同时创建服务器和客户端，可以将'--role'设置为'both'。

进入项目目录:

cd my-payment-server

安装项目依赖: CLI在生成项目后会自动尝试安装依赖。如果自动安装失败，请手动运行：
```
npm install
```

服务器配置

MCP客户端需要以下配置信息来连接并使用MCP服务器。这些信息通常在客户端的配置文件中指定，而不是在服务器端代码中硬编码。

MCP客户端示例配置（JSON格式，用于与MCP服务器建立连接）：

{
  "name": "BEEP Payment Server",
  "description": "一个提供BEEP支付和流式计费功能的MCP服务器",
  "version": "1.0.0",
  "capabilities": {
    "tools": {
      "checkBeepApi": {
        "name": "checkBeepApi",
        "description": "检查BEEP API的健康状态。"
      },
      "requestAndPurchaseAsset": {
        "name": "requestAndPurchaseAsset",
        "description": "使用HTTP 402 Payment Required流程请求并购买资产。"
      },
      "issuePayment": {
        "name": "issuePayment",
        "description": "发起流式支付会话，并根据提供的资产进行计费。"
      },
      "pauseStreaming": {
        "name": "pauseStreaming",
        "description": "暂停指定的流式支付会话。"
      },
      "startStreaming": {
        "name": "startStreaming",
        "description": "启动指定的流式支付会话，开始计费。"
      },
      "stopStreaming": {
        "name": "stopStreaming",
        "description": "停止指定的流式支付会话并结算所有费用。"
      }
    }
  },
  "transport": {
    // Stdio模式配置示例：
    "type": "stdio",
    "command": "node", // 用于启动服务器进程的命令
    "args": ["dist/mcp-server.js"] // 传递给命令的参数，指向服务器的入口脚本
  }
  /*
  // HTTP/HTTPS模式配置示例：
  "transport": {
    "type": "http",
    "url": "https://your-server-domain.com/mcp" // 服务器的公共访问URL
  }
  */
}

请注意：

'command' 和 'args' 字段的值应指向你实际服务器项目的启动脚本（通常在 'dist/mcp-server.js'）。
'url' 字段应替换为你的HTTP/HTTPS服务器的实际公共访问URL。
'BEEP_API_KEY'（BEEP平台API密钥）应在服务器项目的 '.env' 文件中配置，而不是在客户端配置中暴露。在项目生成后，CLI会提示你输入API密钥并写入'.env'文件。

基本使用方法

配置BEEP API密钥: 在生成的项目根目录下的 '.env' 文件中，填写你的 'BEEP_API_KEY'。这是与BEEP支付平台通信所必需的。

BEEP_API_KEY=your_secret_beep_api_key_here
COMMUNICATION_MODE=https # 或 stdio

构建和启动服务器:

npm run build  # 编译TypeScript代码
npm start      # 启动MCP服务器

MCP客户端集成: 你的LLM客户端（例如自定义AI代理或支持MCP的IDE插件）现在可以通过配置中指定的传输协议（HTTP/HTTPS或Stdio）连接到这个MCP服务器。一旦连接成功，客户端就可以发现并调用服务器上注册的BEEP支付工具来执行支付相关操作。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息