ZBD MCP Server

Integrations

  • Enables sending and receiving Bitcoin payments via the Lightning Network, creating payment requests, validating Lightning addresses, and managing Bitcoin transactions.

  • Provides tools for working with the Bitcoin Lightning Network, including sending payments to Lightning addresses, creating payment requests, and decoding charges.

ZBD MCP 服务器

将比特币权力添加到您的 LLM。

基础 SDK

此 MCP 服务器使用官方 TypeScript SDK -- https://github.com/modelcontextprotocol/typescript-sdk

先决条件

  • Node.js 23+(或 Bun/Deno/任何支持运行 .ts 文件的版本)
  • Bun(用于构建可执行文件)
  • 用于支付处理的 ZBD API 密钥

ZBD 设置

从 ZBD 开发者仪表板获取您的 API 密钥,并将其放入ZBD_API_KEY=XXXXXXXXXXXX下的新.env文件中(查看.env.example了解示例)。

完成后,运行pnpm build命令并在客户端(例如 Claude Desktop 或 Cursor)上设置 MCP 服务器。

安装 Bun

如果您尚未安装 Bun,则可以使用以下方法之一进行安装:

macOS 和 Linux

# Using curl (recommended) curl -fsSL https://bun.sh/install | bash # Using Homebrew brew install oven-sh/bun/bun # Using npm npm install -g bun

视窗

# Using PowerShell powershell -c "irm bun.sh/install.ps1|iex" # Using npm npm install -g bun # Using Scoop scoop install bun

通过运行以下命令验证您的安装:

bun --version

安装

pnpm install

故障排除

  • 使用ps aux | grep mcp-zbd | grep -v grep列出所有正在运行的 ZBD MCP 服务器实例。
  • 使用pkill -f mcp-zbd杀死任何可能残留的重复 ZBD MCP 服务器实例。

项目结构

该项目演示了构建 MCP 工具的模块化方法:

  • 每个工具都在src目录中自己的 TypeScript 文件中定义
  • 每个工具都可以构建到bin目录中的独立可执行文件中
  • index.ts提供实际的工具实现

可用工具

  1. ZBDsrc/zbd.ts ):用于全球比特币闪电支付的 ZBD API

创建新工具

要创建新工具:

  1. src目录中创建一个新的 TypeScript 文件(例如src/mytool.ts
  2. 使用现有工具作为模板
  3. package.json添加构建脚本:
"build:mytool": "mkdir -p bin && bun build src/mytool.ts --compile --minify --sourcemap --outfile bin/mcp-mytool"
  1. 更新build:all脚本以包含您的新工具

用法

构建可执行文件

# Build all tools pnpm build # Build a specific tool pnpm build:zbd

生成的可执行文件将位于bin目录中,可以直接运行:

./bin/mcp-zbd

光标注释

当将这些工具与 Cursor 一起使用时,请始终使用可执行文件的完整路径:

/path/to/your/project/bin/mcp-zbd

或者,您可以直接使用 Node 运行 TypeScript 文件:

/path/to/node ~/path/to/project/src/index.ts

测试

# Run all tests pnpm test # Run tests in watch mode pnpm test:watch # Run tests with coverage pnpm test:coverage

ZBD.ts 工具可用

ZBD MCP 服务器中提供以下工具:

  1. send-lightning-payment - 使用 ZBD 将比特币闪电网络付款发送到闪电地址
  2. send-gamertag-payment - 向 ZBD Gamertag 发送比特币付款
  3. create-gamertag-charge - 为 ZBD 用户生成付款请求
  4. validate-lightning-address - 验证闪电地址的有效性
  5. create-lightning-charge - 生成 Lightning 地址的付款请求
  6. get-userid-by-gamertag - 从 ZBD Gamertag 检索用户 ID
  7. get-gamertag-by-userid - 从用户 ID 检索 ZBD 玩家代号
  8. send-email-payment - 向任何电子邮件发送即时比特币付款
  9. get-wallet-info - 检索有关 ZBD 项目钱包的所有数据
  10. check-supported-region - 验证用户是否来自受支持的区域
  11. get-zbd-ip-addresses - 获取 ZBD 服务器的官方 IP 地址
  12. internal-transfer - 在两个项目之间进行资金转移
  13. create-withdrawal-request - 创建比特币提款二维码
  14. get-withdrawal-request - 检索有关单个提款请求的所有数据
  15. send-payment - 发送比特币闪电网络付款
  16. get-payment - 检索有关单笔付款的所有数据
  17. decode-charge - 了解收费二维码的内部属性
  18. create-charge - 创建新的比特币闪电网络费用
  19. get-charge - 检索有关单笔费用的所有数据
  20. create-voucher - 创建一次性使用的 ZBD 优惠券,任何 ZBD 用户都可以兑换
  21. get-voucher - 检索有关 ZBD 优惠券的详细信息
  22. redeem-voucher - 兑换 ZBD 券以存入您的项目钱包
  23. revoke-voucher - 撤销有效的 ZBD 凭证并将 Sats 回收到您的项目钱包
  24. send-batch-lightning-payments - 通过单个请求向闪电地址发送多个比特币闪电网络付款
-
security - not tested
F
license - not found
-
quality - not tested

为 LLM 添加比特币支付功能的服务器,支持发送/接收付款、创建费用、管理钱包以及执行其他比特币闪电网络操作。

  1. Base SDK
    1. Prerequisites
      1. ZBD Setup
        1. Installing Bun
          1. macOS and Linux
          2. Windows
        2. Installation
          1. Troubleshooting
            1. Project Structure
              1. Available Tools
            2. Creating New Tool
              1. Usage
                1. Building Executables
              2. Cursor Notes
                1. Testing
                  1. ZBD.ts Tools Available
                    ID: bvmldvy5ih