Rgb MCP Server

🚀 RGB API MCP Server

このサーバーは、RGB Lightning Node APIとの統合を提供するModel Context Protocol (MCP) サーバーです。AIアシスタントがRGBアセット、Lightning Networkの操作、およびBitcoinのオンチェーントランザクションとやり取りできるようになります。

✨ 主な機能

• ノード操作：ノードの状態を確認し、ネットワーク情報を取得します。
• RGBアセット管理：アセットを一覧表示し、残高を確認し、RGBアセットを送信します。
• Lightning Network：請求書を作成・支払いし、チャネルを管理します。
• オンチェーントランザクション：アドレスを生成し、Bitcoinを送信し、トランザクションを一覧表示します。
• スワップ操作：アセットのスワップを一覧表示し、管理します。

🚀 クイックスタート

npx

Cursor、Claude Desktop、Trae、またはCherry StudioなどのMCPクライアントで、このサーバーを直接使用できます。

⚠️ 重要提示

以下のコマンドで実行する際、xxxxxxxxxxxxxxxxxxxx をあなたのRGB APIキーに置き換えてください。または /path/rgbapi.key のパスを指定してください。

MCPクライアントの設定

MCPクライアント（例：Claude Desktopの設定）に以下の設定を追加してください。

{
    "mcpServers": {
        "rgb-mcp-server": {
            "command": "npx",
            "args": [
                "-y",
                "rgb-mcp-server"
            ],
            "env": {
                "RGB_API_BASE_URL": "http://localhost:3000",
                "RGB_API_KEY": "xxxxxxxxxxxxxxxxxxxx" // オプション: RGB APIキー または /path/rgbapi.key
            }
        }
    }
}

📦 インストール

開発者がこのプロジェクトに貢献したり使用したりする場合の手順です。

1. Node.jsがインストールされていることを確認してください（バージョン16以上を推奨）
2. 依存関係をインストールします。

npm install rgb-mcp-server

💻 使用例

基本的な使用法

パッケージをインストールした後、Node.jsアプリケーションでプログラム的に使用できます。

import { getRGBMcpServer } from "rgb-mcp-server";

// RGB MCPサーバーを初期化
const rgbMcpServer = await getRGBMcpServer({
    baseUrl: process.env.RGB_API_BASE_URL || 'http://localhost:3000',  // RGB APIサーバーのURL
    apiKey: process.env.RGB_API_KEY,                                   // オプション: 認証用のAPIキー
    timeout: 30000                                                     // オプション: リクエストのタイムアウト時間（ミリ秒）
});

// 利用可能なツールにアクセス
const rgbTools = rgbMcpServer._registeredTools;
console.log('利用可能なRGBツール:', Object.keys(rgbTools));

利用可能なツール

サーバーは以下のMCPツールを提供します。

1. rgb_get_node_info - RGBノードの情報を取得
2. rgb_get_node_status - ノードの状態と稼働時間を取得
3. rgb_list_assets - すべてのRGBアセットを一覧表示
4. rgb_get_asset_balance - 特定のアセットの残高を取得
5. rgb_send_asset - RGBアセットを送信
6. rgb_generate_address - 新しいオンチェーンアドレスを生成
7. rgb_list_transactions - オンチェーントランザクションを一覧表示
8. rgb_send_bitcoin - アドレスにBitcoinを送信
9. rgb_create_lightning_invoice - Lightning請求書を作成
10. rgb_pay_lightning_invoice - Lightning請求書を支払う
11. rgb_list_lightning_channels - Lightningチャネルを一覧表示
12. rgb_list_swaps - 利用可能なスワップを一覧表示
13. rgb_create_swap - 新しいアセットスワップを作成

📄 ライセンス

MIT