Bitcoin MCP Server

Bitcoin MCP 服务

这是一个基于 Go 的服务，通过模型上下文协议（MCP）使用各种 RPC 命令与 Bitcoin 节点交互，提供统一的接口。该服务将 Bitcoin RPC 功能划分为逻辑类别，并提供简洁、文档完善的 API，用于访问区块链数据和执行相关操作。

功能

• 使用模型上下文协议提供全面的 Bitcoin RPC 接口
• 按功能类别组织：
  • 区块链操作
  • 内存池操作
  • UTXO 操作
  • 区块链管理
• 安全身份验证
• 全面的错误处理
• 简洁且文档完善的 API

前置条件

• Go 1.24 或更高版本
• 已启用 RPC 的 Bitcoin Core 节点
• 具备 Bitcoin RPC 命令的基础知识

安装

1. 克隆仓库：

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

2. 安装依赖项：

go mod download

3. 构建服务：

go build -o bitcoin-mcp

配置

创建配置文件（config.json），其结构如下：

{
    "bitcoin": {
        "rpc_url": "http://localhost:8332",
        "username": "your_rpc_username",
        "password": "your_rpc_password"
    },
    "server": {
        "port": 8080,
        "host": "localhost"
    }
}

运行服务

1. 启动已启用 RPC 的 Bitcoin Core 节点：

bitcoind -server -rpcuser=your_rpc_username -rpcpassword=your_rpc_password

2. 启动 MCP 服务：

./bitcoin-mcp -config config.json

或使用环境变量：

BITCOIN_RPC_URL=http://localhost:8332 \
BITCOIN_RPC_USER=your_rpc_username \
BITCOIN_RPC_PASS=your_rpc_password \
./bitcoin-mcp

API 用法

该服务提供 RESTful API，用于访问 Bitcoin RPC 命令。以下是一些示例：

获取区块链信息

curl -X POST http://localhost:8080/api/v1/blockchain/info

获取区块数据

curl -X POST http://localhost:8080/api/v1/blockchain/block \
  -H "Content-Type: application/json" \
  -d '{"blockhash": "0000000000000000000123456789abcdef", "verbose": true}'

获取内存池信息

curl -X POST http://localhost:8080/api/v1/mempool/info

开发

项目结构

bitcoin-mcp/
├── cmd/
│   └── server/          # Main server application
├── pkg/
│   ├── bitcoin/         # Bitcoin RPC client
│   └── tools/           # RPC command implementations
├── config.json          # Configuration file
└── README.md           # This file

添加新的 RPC 命令

1. 在 Bitcoin 客户端的 pkg/bitcoin/client.go 中添加方法
2. 在 pkg/tools/ 中创建或更新相应的工具
3. 在相应类别中注册该工具
4. 为新功能添加测试

测试

运行测试套件：

go test ./...

安全注意事项

• 切勿在公共仓库中公开 RPC 凭据
• 为 RPC 访问使用安全密码
• 考虑对公共 API 进行速率限制
• 验证所有输入参数
• 清理错误消息

贡献

1. Fork 仓库
2. 创建功能分支
3. 提交更改
4. 推送到该分支
5. 创建 Pull Request

提交更改时，请遵循贡献指南。

文档

如需详细的 API 文档和规范，请参阅：

• API 规范
• GoDoc 文档

许可证

[指定许可证信息]

支持

如需支持，请：

1. 查看文档
2. 搜索现有问题
3. 如有需要，创建新问题

致谢

• Bitcoin Core 开发者
• Go 社区
• 本项目的所有贡献者