Bitcoin

🚀 Bitcoin-MCP

Bitcoin-MCP は、Bitcoin 関連の情報を取得できるサービスです。Goose と連携することで、Bitcoin ブロックやトランザクションの情報を簡単に取得できます。

🚀 クイックスタート

Bitcoin-MCP を使用するには、まずサーバーを起動する必要があります。以下の手順に従って、サーバーをセットアップしましょう。

📦 インストール

🎮 リポジトリのクローン

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 拡張機能の使用

Goose で Bitcoin MCP 拡張機能を使用するには、以下の手順に従います。

💻 インストールと設定

1. Bitcoin-MCP サーバーの起動 Bitcoin-MCP サーバーが起動し、http://localhost:3000 で待機していることを確認してください。
2. Goose 拡張機能の設定 Goose の拡張管理画面で、以下の手順を実行します。
   • 新しい STDIO タイプの拡張機能を追加します。
   • 以下の情報を入力します。
     • 名前: Bitcoin-MCP
     • コマンド: node
     • パラメータ: bitcoin-mcp/index.js
3. 拡張機能の有効化 追加した 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 を使って詳細なエラー情報を記録します。これらの情報はクライアントの応答に含まれ、デバッグに役立ちます。

🤝 貢献ガイド

貢献を歓迎します！問題の修正や機能の追加など、GitHub への Pull Request や Issue の投稿を大歓迎します。

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。