RGB API

mcp server of rgb api

typescript

1

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "lnfi-network-rgb-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "rgb-mcp-server"
      ],
      "env": {
        "RGB_API_KEY": "xxxxxxxxxxxxxxxxxxxx",
        "RGB_API_BASE_URL": "http://localhost:3000"
      }
    }
  }
}

You can run a lightweight MCP server that bridges RGB Lightning Node APIs with your preferred MCP clients. This server lets you manage RGB assets, handle Lightning invoices and channels, and perform on-chain Bitcoin actions through a simple, configurable interface.

How to use

Start by running the server with an MCP client. You provide your RGB API base URL and an optional API key, and then connect your MCP client to the local server. Once running, you will see tools exposed for node information, asset management, Lightning operations, and on-chain transactions. Use your MCP client to invoke these tools and perform tasks like listing assets, generating addresses, creating invoices, paying invoices, swapping assets, and more.

How to install

Prerequisites: you need Node.js version 16 or higher.

Install the MCP server package locally.

npm install rgb-mcp-server

Run the server using the MCP command with the required environment variables. The server runs as a local process that you connect to with MCP clients.

npx -y rgb-mcp-server

Configuration and usage notes

Provide the RGB API base URL and optional API key to the server so MCP clients can access RGB features. Example environment variables to pass when starting the server:

RGB_API_BASE_URL=http://localhost:3000
RGB_API_KEY=xxxxxxxxxxxxxxxxxxxx

Available operations you can perform through MCP

Through MCP you can check node status, list RGB assets, get asset balances, send RGB assets, generate on-chain addresses, send bitcoins, create and pay Lightning invoices, manage Lightning channels, and list or create asset swaps.

Security considerations

Protect your RGB API key and restrict access to the MCP server to trusted clients. Use strong network safeguards and rotate API keys as needed.

Troubleshooting tips

If your MCP client cannot connect, verify that the server is running, confirm the RGB_API_BASE_URL is reachable, and ensure the RGB_API_KEY (if used) is correct. Check environment variables are accessible to the running process and that the port used by the RGB API is open.

Available tools

rgb_get_node_info

Get RGB node information such as status and identity.

rgb_get_node_status

Check node status and uptime.

rgb_list_assets

List all RGB assets available to the node.

rgb_get_asset_balance

Retrieve balance for a specific RGB asset.

rgb_send_asset

Send RGB assets to another address.

rgb_generate_address

Generate a new on-chain Bitcoin address.

rgb_list_transactions

List on-chain Bitcoin transactions.

rgb_send_bitcoin

Send Bitcoin to a specified address.

rgb_create_lightning_invoice

Create a Lightning Network invoice.

rgb_pay_lightning_invoice

Pay a Lightning Network invoice.

rgb_list_lightning_channels

List Lightning Network channels.

rgb_list_swaps

List available asset swaps.

rgb_create_swap

Create a new asset swap.