Zbd MCP Server

🚀 ZBD MCP 服务器

本项目可帮助您为大语言模型（LLM）添加比特币功能。不过需要注意的是，该项目已弃用，请改用：https://github.com/zebedeeio/zbd-payments-typescript-sdk/tree/main/packages/mcp-server 。

🚀 快速开始

基础 SDK

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

先决条件

• Node.js 23+（或 Bun/Deno/支持运行 .ts 文件的任何环境）
• Bun（用于构建可执行文件）
• ZBD API 密钥用于处理付款

ZBD 设置

从 ZBD 开发者控制台获取您的 API 密钥，并将其添加到项目根目录下的新 .env 文件中，格式为 ZBD_API_KEY=XXXXXXXXXXXX（参考 .env.example 作为示例）。完成配置后运行 pnpm build 命令，并在您的客户端上设置 MCP 服务器（例如 Claude Desktop 或 Cursor）。

📦 安装指南

安装 Bun

如果您没有安装 Bun，请使用以下方法之一进行安装：

macOS 和 Linux

# 使用 curl（推荐）
curl -fsSL https://bun.sh/install | bash

# 使用 Homebrew
brew install oven-sh/bun/bun

# 使用 npm
npm install -g bun

Windows

# 使用 PowerShell
powershell -c "irm bun.sh/install.ps1|iex"

# 使用 npm
npm install -g bun

# 使用 Scoop
scoop install bun

通过运行以下命令验证安装：

bun --version

安装项目依赖

pnpm install

💻 使用示例

初始化环境

1. 创建 .env 文件并添加 ZBD_API_KEY。
2. 安装依赖：pnpm install

启动服务器

pnpm dev

停止服务器

Ctrl + C

🔧 故障排除

• 使用 ps aux | grep mcp-zbd | grep -v "grep" 查看进程。
• 使用 lsof -i :3000 或其他端口查找占用的进程。

📚 详细文档

项目结构

.
├── .env.example         # 环境变量示例文件
├── src                 # 源代码目录
│   ├── index.ts        # 入口文件
│   └── utils           # 工具函数
└── package.json       # 项目依赖和配置

提供的工具

以下是 MCP 服务器支持的所有功能列表：

1. 发送闪电网络支付 - 向一个或多个 Lightning 地址发送比特币。
2. 发送批量闪电网络支付 - 在单个请求中向多个 Lightning 地址发送比特币。
3. 创建充电 - 创建一个新的 Bitcoin Lightning Network 充电。
4. 获取充电 - 获取关于单个充电的所有数据。
5. 解码充电 - 了解充电 QR 码的内部属性。
6. 发送付款 - 发送 Bitcoin Lightning Network 付款。
7. 获取付款 - 获取关于单个付款的所有数据。
8. 创建汇款请求 - 创建比特币提款 QR 码。
9. 获取汇款请求 - 获取关于单个提款请求的所有数据。
10. 撤销汇款请求 - 撤销有效的提款请求并收回资金到项目钱包。
11. 发送电子邮件付款 - 向任何电子邮件地址发送即时比特币付款。
12. 创建优惠券 - 创建一个一次性的 ZBD 优惠券，可用于任何 ZBD 用户。
13. 获取优惠券 - 获取关于单个优惠券的所有数据。
14. 兑换优惠券 - 兑换 ZBD 优惠券以获得项目钱包的积分。
15. 内部转账 - 在两个项目之间进行资金转移。
16. 检查支持区域 - 验证用户是否来自一个受支持的地区。
17. 获取 ZBD IP 地址 - 获取 ZBD 服务器的官方 IP 地址。
18. 创建撤单请求 - 创建比特币提款 QR 码。
19. 内部转账 - 在两个项目之间进行资金转移。
20. 创建优惠券 - 创建一个一次性的 ZBD 优惠券，可用于任何 ZBD 用户。
21. 获取优惠券 - 获取关于单个优惠券的所有数据。
22. 兑换优惠券 - 兑换 ZBD 优惠券以获得项目钱包的积分。
23. ** revoke-voucher - 撤销有效的提款请求并收回资金到项目钱包。

⚠️ 注意事项

⚠️ 重要提示

所有 API 请求都需要有效的 ZBD_API_KEY。

💡 使用建议

确保服务器运行在安全的环境中，避免泄露 API 密钥。