Skip to main content

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’s MCP server exposes 313 tools across 31 modules, giving Claude Code, Cursor, Windsurf, and any other MCP-compatible client direct access to agent orchestration, vector memory, swarm coordination, GitHub automation, background workers, lifecycle hooks, and real-time progress tracking — all from within a single registered server. Once registered, every tool appears natively in the client’s tool palette with full schema validation and O(1) lookup.

Tool Categories

CategoryKey ToolsCount
Coordinationswarm_init, agent_spawn, task_orchestrate~50
Monitoringswarm_status, agent_list, agent_metrics, task_status~40
Memory & Neuralmemory_usage, neural_status, neural_train, neural_patterns~60
GitHubgithub_swarm, repo_analyze, pr_enhance, issue_triage, code_review~80
Workersworker/run, worker/status, worker/alerts, worker/history~12
Hookshooks/pre-*, hooks/post-*, hooks/route, hooks/session-*, hooks/teammate-*, hooks/task-*~33
Progressprogress/check, progress/sync, progress/summary, progress/watch~4

Starting the MCP Server

Register Ruflo once with your client. The mcp start command handles transport negotiation, session management, and tool registration automatically.
# Register with Claude Code
claude mcp add ruflo -- npx ruflo@latest mcp start

# List all available tools
npx ruflo@latest mcp tools

# Filter by category
npx ruflo@latest mcp tools --category coordination
The AGENTS.md guide defines a four-step loop that every agent session should follow. Tools are the bookends; you do the real work in the middle.
1. memory_search(query="task keywords")
   → Find existing patterns (score > 0.7 means reuse, 0.5–0.7 means adapt)

2. swarm_init(topology="hierarchical")
   → Create a coordination record (returns instantly — don't wait on it)

3. YOU do the work — write code, run commands, create files
   → Claude Code / Codex is the executor; Ruflo is the ledger

4. memory_store(key="pattern-x", value="what worked", namespace="patterns")
   → Persist the successful pattern for future sessions
Ruflo is the harness, not the executor. After calling any coordination tool, immediately continue doing your own work. Tool calls return instantly and create records only — they do not run code on your behalf.

Programmatic Usage

Build your own MCP server on top of Ruflo’s transport layer using @claude-flow/mcp. The package has zero @claude-flow/* dependencies, so it stays lightweight in plugin contexts.
import { quickStart, defineTool } from '@claude-flow/mcp';

const server = await quickStart({
  transport: 'stdio',
  name: 'My MCP Server',
});

server.registerTool(defineTool(
  'greet',
  'Greet a user',
  {
    type: 'object',
    properties: {
      name: { type: 'string', description: 'User name' }
    },
    required: ['name']
  },
  async ({ name }) => ({ message: `Hello, ${name}!` })
));

await server.start();

Server Characteristics

FeatureValue
MCP spec compliance2025-11-25
Startup time<400ms
Tool registration<10ms per tool
Tool lookupO(1)
Connection poolMax 10 connections, configurable
Transportsstdio, HTTP, WebSocket, in-process
Session managementTimeout handling, authentication tokens
SecurityCORS, Helmet, Bearer token auth
The server supports full MCP 2025-11-25 features: Resources (list, read, subscribe with caching), Prompts (templates with arguments and embedded resources), Tasks (async operations with progress reporting and cancellation), and cursor-based pagination for large tool lists.

Explore Further

Coordination Tools

swarm_init, agent_spawn, task_orchestrate, and the full swarm lifecycle API.

Memory Tools

memory_search, memory_store, neural_train, neural_patterns, and the SONA learning system.

Monitoring Tools

swarm_status, agent_list, agent_metrics, task_status, and background worker observability.

Claude Code Integration

End-to-end setup guide: register the MCP server, configure hooks, and run your first swarm.

Build docs developers (and LLMs) love