Documentation Index
Fetch the complete documentation index at: https://mintlify.com/ruvnet/ruflo/llms.txt
Use this file to discover all available pages before exploring further.
ruflo mcp manages the Model Context Protocol server that bridges Ruflo to Claude Code and any other MCP-compatible client. The MCP server exposes Ruflo’s full tool catalog (agent management, swarm coordination, memory operations, hooks, and more) as structured tool calls. In the default stdio transport, Claude Code communicates with it directly through the process I/O streams — no port required.
Synopsis
Subcommands
| Subcommand | Description |
|---|---|
start | Start the MCP server |
stop | Stop the running MCP server |
status | Show server status, PID, uptime, and health |
health | Perform a deep health check against a running server |
restart | Stop and start the server in one step |
tools | List all registered tools, optionally filtered by category |
toggle | Enable or disable specific tools by name |
exec | Execute an MCP tool directly from the CLI |
logs | Show recent server log entries |
Transports
| Transport | Value | Description |
|---|---|---|
stdio | stdio | (Default) Standard I/O — used by Claude Code’s native MCP integration |
| HTTP | http | JSON-RPC over HTTP; exposes /health and /rpc endpoints |
| WebSocket | websocket | Persistent WebSocket connection at /ws |
The Then verify with
stdio transport is the recommended transport for Claude Code integration. To register Ruflo with Claude Code, run:claude mcp list.start
Start the MCP server. Detects an already-running server before starting and auto-recovers from stale PID files.Transport protocol. One of:
stdio, http, websocket.Listening port. Only relevant for
http and websocket transports.Bind address. Only relevant for
http and websocket transports.Comma-separated list of tool names to enable, or
all to enable everything.Detach from the terminal and run as a background daemon.
Kill any existing server on the same transport/port before starting.
http transport, it exposes:
http://<host>:<port>/health— liveness endpointhttp://<host>:<port>/rpc— JSON-RPC 2.0 endpoint
websocket, it exposes ws://<host>:<port>/ws.
stop
Gracefully drain pending requests, close connections, and terminate the server process.Skip the graceful drain and send an immediate kill signal.
status
Print the current server state — running or stopped, PID, transport, host, port (non-stdio only), uptime, and health metrics.stdio transport, the server is considered running if process.stdin is not a TTY (i.e. the process is attached to a pipe, as when Claude Code has invoked it). Pass --format json for machine-readable output suitable for monitoring scripts.
health
Run a deep health check against the server (not just PID-file inspection).healthy/unhealthy verdict and a metrics map. Exits non-zero if the server is unhealthy so the command can be used in CI readiness gates.
restart
Restart the server in one atomic step: stop (graceful) + start with the same options.Force-kill the existing server before restarting.
tools
List every registered MCP tool, grouped by category.Filter to a single category. Valid values:
agent, swarm, memory, hooks, config, system.Show only enabled tools (skips disabled ones).
| Category | Example tools |
|---|---|
agent | agent_spawn, agent_list, agent_terminate, agent_status, agent_health, agent_pool, agent_logs |
swarm | swarm_init, swarm_status, swarm_scale, swarm_shutdown |
memory | memory_store, memory_search, memory_list, memory_stats, memory_import |
hooks | hooks_pre-edit, hooks_post-edit, hooks_pre-command, hooks_post-command, hooks_route, hooks_explain, hooks_pretrain, hooks_metrics, hooks_list, hooks_model-route, hooks_model-outcome, hooks_task-completed, hooks_teammate-idle |
config | config_load, config_save, config_validate |
system | system_info, system_health, system_metrics |
toggle
Enable or disable tools by name without restarting the server.Comma-separated tool names to enable.
Comma-separated tool names to disable.
exec
Execute a registered MCP tool directly from the CLI, bypassing Claude Code. Useful for testing tools in isolation or scripting.Name of the tool to execute (e.g.
swarm_init).JSON-encoded parameter object. Defaults to
{} if omitted.logs
Show recent server log entries.Number of lines to display.
Stream new log lines as they arrive.
Filter to a minimum log level:
debug, info, warn, or error.