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许可证。