Rgb MCP Server

🚀 RGB API MCP Server

RGB API MCP Server是一個模型上下文協議（MCP）服務器，可與RGB閃電節點API集成。該服務器使AI助手能夠與RGB資產、閃電網絡操作和比特幣鏈上交易進行交互。

✨ 主要特性

• 節點操作：檢查節點狀態，獲取網絡信息
• RGB資產管理：列出資產、檢查餘額、發送RGB資產
• 閃電網絡：創建/支付發票，管理通道
• 鏈上交易：生成地址、發送比特幣、列出交易
• 交換操作：列出並管理資產交換

🚀 快速開始

npx

你可以通過運行以下命令，直接在MCP客戶端（如Cursor、Claude Desktop、Trae或Cherry Studio）中使用此服務器。

⚠️ 重要提示

請將 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 - 向地址發送比特幣
9. rgb_create_lightning_invoice - 創建閃電網絡發票
10. rgb_pay_lightning_invoice - 支付閃電網絡發票
11. rgb_list_lightning_channels - 列出閃電網絡通道
12. rgb_list_swaps - 列出可用的交換
13. rgb_create_swap - 創建新的資產交換

📄 許可證

本項目採用MIT許可證。