Obtain Your RGB API Key
- If you are running your own RGB Lightning Node API server, generate or locate your API key file. This key is required to authenticate with the RGB API.
- The API key may be given to you during setup or installation of your RGB node. If unsure, refer to the documentation of your RGB API server or look for a file named like
rgbapi.key
.
Copy the RGB API Key or Its File Path
- If you have the API key as text, copy it.
- If it is a file, note the absolute path to the file (e.g.,
/home/user/.rgb/rgbapi.key
).
Fill in the FastMCP Connection Interface
- In your MCP client (such as Cursor, Claude Desktop, Trae, or Cherry Studio), locate the FastMCP connection interface.
- Click the “Install Now” or similar button for the RGB MCP integration.
Enter the Required ENV Values
- Set
RGB_API_BASE_URL
to the address of your RGB API server (e.g., http://localhost:3000
or your actual server URL).
- Set
RGB_API_KEY
to either:
- The API key string, or
- The absolute file path to your
rgbapi.key
file, as applicable.
Example:
RGB_API_BASE_URL = http://localhost:3000
RGB_API_KEY = xxxxxxxxxxxxxxxxxxxx (or /path/rgbapi.key)
- Finish and Connect
- Save/apply your changes in the MCP client interface.
- The integration should now be able to communicate with your RGB Lightning Node APIs using the provided API key.
Note: If you do not yet have an API key, refer to your RGB API server documentation for instructions on how to generate one. Typically, this involves running a command or completing initial server setup.