返回市场
zbz-mcp-服务器

zbz-mcp-服务器

作者:zbdpay3 星标更新:2025-04-24

项目介绍

⚠️ 弃用通知

🚨 此MCP服务器已不再维护。🚨

我们已经迁移到一个新的改进版MCP服务器实现。所有未来的更新、功能和支持都将在此提供。

👉 请迁移至新的MCP服务器:https://github.com/zebedeeio/zbd-payments-typescript-sdk/tree/main/packages/mcp-server

此仓库将保持可用以供参考,但不建议用于生产环境。


ZBD MCP服务器(已弃用--请改用:https://github.com/zebedeeio/zbd-payments-typescript-sdk/tree/main/packages/mcp-server)

为您的LLM添加比特币功能。

基础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命令并在客户端(如Claude Desktop或Cursor)上设置MCP服务器。

安装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

故障排除

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

项目结构

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

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

可用工具

  1. ZBD (src/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脚本以包含您的新工具

使用

构建可执行文件

# 构建所有工具
pnpm build

# 构建特定工具
pnpm build:zbd

生成的可执行文件将在bin目录下,可以直接运行:

./bin/mcp-zbd

Cursor注意事项

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

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

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

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

测试

# 运行所有测试
pnpm test

# 在监视模式下运行测试
pnpm test:watch

# 运行带有覆盖率的测试
pnpm test:coverage

ZBD.ts可用工具

以下工具在ZBD MCP服务器中可用:

  1. send-lightning-payment - 使用ZBD向Lightning地址发送比特币闪电网络支付
  2. send-gamertag-payment - 向ZBD Gamertag发送比特币支付
  3. create-gamertag-charge - 为ZBD用户生成付款请求
  4. validate-lightning-address - 验证Lightning地址的有效性
  5. create-lightning-charge - 为Lightning地址生成付款请求
  6. get-userid-by-gamertag - 根据ZBD Gamert_标签检索用户ID
  7. get-gamertag-by-userid - 根据用户ID检索ZBD Gamertag
  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 - 理解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 - 在单个请求中向多个Lightning地址发送比特币闪电网络支付