Zbd MCP Server

🚀 ZBD MCP 服務器

本項目已棄用，請改用：https://github.com/zebedeeio/zbd-payments-typescript-sdk/tree/main/packages/mcp-server。此項目可以為您的大語言模型（LLM）添加比特幣功能。

🚀 快速開始

初始化環境

1. 創建 .env 文件並添加 ZBD_API_KEY。
2. 安裝依賴：pnpm install

啟動服務器

pnpm dev

停止服務器

Ctrl + C

✨ 主要特性

此 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 - 撤銷有效的提款請求並收回資金到項目錢包。

📦 安裝指南

先決條件

• 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       # 項目依賴和配置

📄 許可證

文檔未提及相關內容，故跳過該章節。

⚠️ 重要提示

所有 API 請求都需要有效的 ZBD_API_KEY。確保服務器運行在安全的環境中，避免洩露 API 密鑰。