Package Exports
- @supcon-international/node-red-mcp-server
- @supcon-international/node-red-mcp-server/lib/server.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@supcon-international/node-red-mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@supcon-international/node-red-mcp-server
Model Context Protocol (MCP) server for Node-RED — allows language models (like Claude, GPT) to interact with Node-RED through a standardized API.
This is an enhanced version based on karavaev-evgeniy/node-red-mcp-server
Description
node-red-mcp-server Node-RED-MCP-Server for handling complex Node-RED tasks autonomously
Enhanced Key Features
- Retrieve and update Node-RED flows via MCP
- Multi-version flow backup system with integrity validation
- Add detailed argument descriptions for tools, making it better for LLM usage and handling complicated tasks
- get available nodes information (name,help,module name) instead of raw code
- install new node via llm
- check module and node set module information and manage states
- Manage tabs and individual nodes
- Search for nodes by type or properties
- Access settings and runtime state
- Trigger inject nodes remotely
- Output and visualize flows and stats
Installation
Global Installation
npm install -g @supcon-international/node-red-mcp-serverLocal Installation
npm install @supcon-international/node-red-mcp-serverUsage
Command Line
node-red-mcp --url http://localhost:1880 --token YOUR_TOKENConfiguration via .env
Create a .env file:
NODE_RED_URL=http://localhost:1880
NODE_RED_TOKEN=YOUR_TOKEN
NODE_MCP_PREFIX=/api/v1 # Optional: API path prefix (e.g., /nodered-api /eventflow-api)
MCP_BACKUP_PATH=/custom/backup/path
MCP_MAX_BACKUPS=10Then run:
node-red-mcpIntegration with Claude or Other LLMs
Start the MCP server or configure Claude Desktop to start it automatically with the tool configuration below.
Configure Claude Desktop:
- Open Claude Desktop app
- Go to Settings → Advanced → Tool Configuration
- Add a new tool configuration:
{
"node-red": {
"command": "npx",
"args": ["@supcon-international/node-red-mcp-server", "--verbose"],
"env(Optional,if None then use default value)": {
"NODE_RED_URL": "http://your-node-red-url:1880",
"NODE_RED_TOKEN": "your-token-if-needed",
"NODE_MCP_PREFIX": "/nodered-api",
"MCP_BACKUP_PATH": "/custom/backup/path",
"MCP_MAX_BACKUPS": "10"
}
}
}or
{
"node-red": {
"command": "node",
"args": [
"/path/to/node-red-mcp-server/bin/node-red-mcp-server.mjs",
"--verbose"
],
"env(Optional,if None then use default value)": {
"NODE_RED_URL": "http://your-node-red-url:1880",
"NODE_RED_TOKEN": "your-token-if-needed",
"NODE_MCP_PREFIX": "/nodered-api",
"MCP_BACKUP_PATH": "/custom/backup/path",
"MCP_MAX_BACKUPS": "10"
}
}
}- Replace
/path/to/node-red-mcp-serverwith the actual path to your installation - Update
NODE_RED_URLto point to your Node-RED instance - Set
NODE_RED_TOKENif your Node-RED instance requires authentication - Set
NODE_MCP_PREFIXif your Node-RED API is behind a reverse proxy or requires a path prefix (e.g.,/nodered-api,/eventflow-api). If not set, it defaults to the standard Node-RED API paths
- After configuration, Claude can interact with your Node-RED instance through the MCP tools.
For more information about the Model Context Protocol, visit the official MCP documentation.
Programmatic Usage
import { createServer } from "node-red-mcp-server";
const server = createServer({
nodeRedUrl: "http://localhost:1880",
nodeRedToken: "YOUR_TOKEN",
verbose: true,
});
await server.start();Configuration Options
CLI Parameters
| Parameter | Short | Description |
|---|---|---|
--url |
-u |
Node-RED base URL |
--token |
-t |
API access token |
--verbose |
-v |
Enable verbose logging |
--backup-path |
Custom backup directory path | |
--max-backups |
Maximum number of backups to keep (default: 10) | |
--help |
-h |
Show help |
--version |
-V |
Show version number |
Environment Variables
| Variable | Description |
|---|---|
NODE_RED_URL |
URL of your Node-RED instance |
NODE_RED_TOKEN |
API access token |
MCP_BACKUP_PATH |
Custom backup directory path |
MCP_MAX_BACKUPS |
Maximum number of backups to keep |
NODE_MCP_PREFIX |
API path prefix for reverse proxy |
MCP Tools
Flow Tools
get-flows— Get all flowsupdate-flows— Update all flowsget-flow— Get a specific flow by IDupdate-flow— Update a specific flow by IDlist-tabs— List all tabs (workspaces)create-flow— Create a new flow tabdelete-flow— Delete a flow tabget-flows-state— Get deployment stateset-flows-state— Change deployment stateget-flows-formatted— Get human-readable flow listvisualize-flows— Generate graph-like view of flows
Node Tools
inject— Trigger an inject nodeget-available-nodes— List available node summary information (name help-doc module)install-node-module- install new node moduleget-node-detailed-info— Detailed info about a node moduleget-node-set-detailed-info- Detailed source code about a node module settoggle-node-module— Enable/disable a node moduletoggle-node-module-set- Enable/disable a node module setfind-nodes-by-type— Locate nodes by typesearch-nodes— Find nodes by name or property
Backup Tools
backup-flows— Create a named backup of current flows with optional reasonlist-backups— List all available flow backups with detailsget-backup-flows— Get the specific flows content from a backup by namebackup-health— Check backup system health and provide recommendations
Settings Tools
get-settings— Get Node-RED runtime settingsget-diagnostics— Fetch diagnostics info
Utility Tools
api-help— Show Node-RED API help
Requirements
- Node.js v16 or newer
- A running Node-RED instance with HTTP API access
License
MIT License Copyright (c) 2025
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.