🚀 Bitcoin-MCP项目

Bitcoin-MCP 是一个与比特币相关的项目，它提供了服务器功能以及可在 Goose 中使用的扩展，能帮助用户查询比特币相关信息，还支持 Lightning 网络功能等。

🚀 快速开始

克隆仓库

使用 Git 克隆 Bitcoin-MCP 项目：

git clone https://github.com/abdelstark/bitcoin-mcp.git
cd bitcoin-mcp

安装依赖项

安装所需的 Node.js 包：

npm install

启动服务器

启动 Bitcoin-MCP 服务器：

node index.js

默认情况下，服务器将在 http://localhost:3000 上运行。

📦 安装指南

克隆仓库

使用 Git 克隆 Bitcoin-MCP 项目：

git clone https://github.com/abdelstark/bitcoin-mcp.git
cd bitcoin-mcp

安装依赖项

安装所需的 Node.js 包：

npm install

启动服务器

启动 Bitcoin-MCP 服务器：

node index.js

默认情况下，服务器将在 http://localhost:3000 上运行。

💻 使用示例

在Goose中使用Bitcoin MCP扩展

安装与配置

• 启动 Bitcoin-MCP 服务器：确保 Bitcoin-MCP 服务器已启动并正在运行，监听地址为 http://localhost:3000。
• 配置 Goose 扩展：在 Goose 的扩展管理界面中，添加一个新的 STDIO 类型扩展，填写以下信息：
  • 名称：Bitcoin-MCP
  • 命令：node
  • 参数：bitcoin-mcp/index.js
• 启用扩展：启用刚添加的 Bitcoin-MCP 扩展。

使用 MCP 服务

在新的 Goose 聊天窗口中输入以下示例问题：

• "What's the latest Bitcoin block?"
• "Give me information about the transaction with TXID abcdef1234567890abcdef1234567890."

Goose 将通过 MCP 服务器返回相关信息。

📚 详细文档

开发设置

请参考 开发设置指南。

Lightning 网络配置（可选）

若需使用 Lightning 网络功能，请在配置文件中添加以下内容：

{
  "lnbitsUrl": "https://demo.lnbits.com",  
  "lnbitsAdminKey": "your_admin_key",      // 必填，用于进行支付
  "lnbitsReadKey": "your_read_key"         // 必填，用于钱包信息查询
}

获取这些值的方法：

1. 在 LNBits 注册账户。
2. 创建一个新的钱包。
3. 转到 API 信息页面以获取你的 API 密钥。

可用工具

请查阅 API 参考文档 了解可用工具的详细信息。

错误处理

服务器采用自定义错误类型来处理比特币操作和区块链查询，并使用 Pino 详细记录错误信息，包含在客户端响应中以便于调试。

🤝 贡献指南

欢迎贡献！无论修复问题还是添加功能，我们都热烈欢迎您的 Pull Request 或 Issue 提交到 GitHub。

📄 许可证

该项目 licensed under the MIT License。