Bitcoin MCP Server

Bitcoin MCP Server

Model Context Protocol（MCP）を使用し、さまざまな RPC コマンドを通じて Bitcoin ノードとやり取りするための、Go ベースのサービスです。サーバーは Bitcoin RPC の機能を論理的なカテゴリに整理し、ブロックチェーンのデータや操作にアクセスするための、わかりやすく文書化された API を提供します。

機能

• Model Context Protocol を使用した包括的な 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 の使用方法

サーバーは Bitcoin RPC コマンドにアクセスするための RESTful API を提供します。以下に例を示します：

ブロックチェーン情報の取得

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. pkg/bitcoin/client.go の Bitcoin クライアントにメソッドを追加します
2. pkg/tools/ に対応するツールを作成または更新します
3. 適切なカテゴリにツールを登録します
4. 新しい機能のテストを追加します

テスト

テストスイートを実行します：

go test ./...

セキュリティに関する考慮事項

• RPC 認証情報を公開リポジトリに決して公開しないでください
• RPC アクセスには安全なパスワードを使用してください
• 公開 API ではレート制限を検討してください
• すべての入力パラメーターを検証してください
• エラーメッセージをサニタイズしてください

コントリビューション

1. リポジトリをフォークします
2. 機能ブランチを作成します
3. 変更をコミットします
4. ブランチにプッシュします
5. Pull Request を作成します

変更を提出する際は、コントリビューションガイドラインに従ってください。

ドキュメント

API の詳細なドキュメントと仕様については、以下を参照してください：

• API 仕様
• GoDoc ドキュメント

ライセンス

[ライセンス情報を指定]

サポート

サポートが必要な場合は、以下をお試しください：

1. ドキュメントを確認する
2. 既存の Issue を検索する
3. 必要に応じて新しい Issue を作成する

謝辞

• Bitcoin Core の開発者
• Go コミュニティ
• このプロジェクトへのすべてのコントリビューター