v2/docs/api/API_DOCUMENTATION.md
Claude-Flow v2.0.0 provides comprehensive AI agent orchestration with 112 MCP tools, 54+ specialized agent types, and advanced swarm intelligence capabilities. This documentation covers the complete API surface for programmatic access to all features.
# Initialize with GitHub authentication (recommended)
npx claude-flow@alpha github init
# Or use API key
export CLAUDE_FLOW_API_KEY="your-api-key"
npx claude-flow@alpha config set --api-key $CLAUDE_FLOW_API_KEY
// Add Claude-Flow as MCP server
claude mcp add claude-flow npx claude-flow@alpha mcp start
// Available MCP servers:
// - claude-flow: 87 native tools
// - ruv-swarm: 25 advanced coordination tools
# Generate session token
npx claude-flow@alpha auth login
# Use token in API calls
curl -H "Authorization: Bearer $(npx claude-flow@alpha auth token)" \
https://api.claude-flow.ai/v2/agents
IMPORTANT: Always use npx claude-flow@alpha (not npx claude-flow)
# ✅ CORRECT - Updated syntax
npx claude-flow@alpha [command] [options]
# ❌ OUTDATED - Do not use
npx claude-flow [command] [options]
# Swarm operations
npx claude-flow@alpha coordination swarm-init --topology hierarchical
npx claude-flow@alpha coordination agent-spawn --type coder
npx claude-flow@alpha coordination task-orchestrate --task "Build API"
# Memory operations
npx claude-flow@alpha memory usage --action store --key project/context
npx claude-flow@alpha memory search --pattern "authentication"
# Performance analysis
npx claude-flow@alpha performance report --timeframe 24h
npx claude-flow@alpha bottleneck analyze --component swarm
# GitHub integration
npx claude-flow@alpha github repo-analyze --repo owner/repo
npx claude-flow@alpha github pr-manage --action create
mcp__claude-flow__swarm_init - Initialize swarm with topologymcp__claude-flow__agent_spawn - Create specialized agentsmcp__claude-flow__task_orchestrate - Coordinate task executionmcp__claude-flow__swarm_status - Monitor swarm healthmcp__claude-flow__agent_list - List active agentsmcp__claude-flow__agent_metrics - Agent performance datamcp__claude-flow__swarm_monitor - Real-time monitoringmcp__claude-flow__topology_optimize - Optimize coordinationmcp__claude-flow__load_balance - Balance agent workloadmcp__claude-flow__coordination_sync - Synchronize agentsmcp__claude-flow__swarm_scale - Scale agent countmcp__claude-flow__swarm_destroy - Terminate swarmmcp__claude-flow__neural_status - Neural system statusmcp__claude-flow__neural_train - Train AI patternsmcp__claude-flow__neural_predict - Make AI predictionsmcp__claude-flow__neural_patterns - Cognitive patternsmcp__claude-flow__model_load - Load AI modelsmcp__claude-flow__model_save - Save trained modelsmcp__claude-flow__wasm_optimize - WASM performancemcp__claude-flow__inference_run - Run AI inferencemcp__claude-flow__pattern_recognize - Pattern detectionmcp__claude-flow__cognitive_analyze - Cognitive analysismcp__claude-flow__learning_adapt - Adaptive learningmcp__claude-flow__neural_compress - Model compressionmcp__claude-flow__ensemble_create - Ensemble modelsmcp__claude-flow__transfer_learn - Transfer learningmcp__claude-flow__neural_explain - AI explainabilitymcp__claude-flow__memory_usage - Store/retrieve datamcp__claude-flow__memory_search - Search memory entriesmcp__claude-flow__memory_persist - Persistent storagemcp__claude-flow__memory_namespace - Namespace managementmcp__claude-flow__memory_backup - Backup memory datamcp__claude-flow__memory_restore - Restore from backupmcp__claude-flow__memory_compress - Compress datamcp__claude-flow__memory_sync - Synchronize memorymcp__claude-flow__cache_manage - Cache operationsmcp__claude-flow__state_snapshot - State snapshotsmcp__claude-flow__context_restore - Context restorationmcp__claude-flow__memory_analytics - Memory analyticsmcp__claude-flow__performance_report - Performance reportsmcp__claude-flow__bottleneck_analyze - Bottleneck detectionmcp__claude-flow__task_status - Task monitoringmcp__claude-flow__task_results - Task resultsmcp__claude-flow__benchmark_run - Run benchmarksmcp__claude-flow__metrics_collect - Collect metricsmcp__claude-flow__trend_analysis - Trend analysismcp__claude-flow__cost_analysis - Cost trackingmcp__claude-flow__quality_assess - Quality assessmentmcp__claude-flow__error_analysis - Error analysismcp__claude-flow__usage_stats - Usage statisticsmcp__claude-flow__health_check - System healthmcp__claude-flow__token_usage - Token trackingmcp__claude-flow__workflow_create - Create workflowsmcp__claude-flow__workflow_execute - Execute workflowsmcp__claude-flow__workflow_export - Export workflowsmcp__claude-flow__automation_setup - Setup automationmcp__claude-flow__pipeline_create - Create pipelinesmcp__claude-flow__scheduler_manage - Manage schedulesmcp__claude-flow__trigger_setup - Setup triggersmcp__claude-flow__workflow_template - Workflow templatesmcp__claude-flow__batch_process - Batch processingmcp__claude-flow__parallel_execute - Parallel executionmcp__claude-flow__sparc_mode - SPARC workflowsmcp__claude-flow__github_repo_analyze - Repository analysismcp__claude-flow__github_pr_manage - Pull request managementmcp__claude-flow__github_issue_track - Issue trackingmcp__claude-flow__github_release_coord - Release coordinationmcp__claude-flow__github_workflow_auto - Workflow automationmcp__claude-flow__github_code_review - Code reviewmcp__claude-flow__github_sync_coord - Sync coordinationmcp__claude-flow__github_metrics - GitHub metricsmcp__claude-flow__daa_agent_create - Create dynamic agentsmcp__claude-flow__daa_capability_match - Match capabilitiesmcp__claude-flow__daa_resource_alloc - Resource allocationmcp__claude-flow__daa_lifecycle_manage - Lifecycle managementmcp__claude-flow__daa_communication - Agent communicationmcp__claude-flow__daa_consensus - Consensus algorithmsmcp__claude-flow__daa_fault_tolerance - Fault tolerancemcp__claude-flow__daa_optimization - Agent optimizationmcp__claude-flow__terminal_execute - Terminal executionmcp__claude-flow__config_manage - Configuration managementmcp__claude-flow__features_detect - Feature detectionmcp__claude-flow__security_scan - Security scanningmcp__claude-flow__backup_create - Create backupsmcp__claude-flow__restore_system - System restorationmcp__claude-flow__log_analysis - Log analysismcp__claude-flow__diagnostic_run - Run diagnosticsmcp__ruv-swarm__swarm_init - Advanced swarm initializationmcp__ruv-swarm__swarm_status - Detailed swarm statusmcp__ruv-swarm__swarm_monitor - Real-time monitoringmcp__ruv-swarm__agent_spawn - Spawn ruv-swarm agentsmcp__ruv-swarm__agent_list - List ruv-swarm agentsmcp__ruv-swarm__agent_metrics - Agent performance metricsmcp__ruv-swarm__task_orchestrate - Advanced task orchestrationmcp__ruv-swarm__task_status - Task status monitoringmcp__ruv-swarm__task_results - Retrieve task resultsmcp__ruv-swarm__neural_status - Neural system statusmcp__ruv-swarm__neural_train - Train neural modelsmcp__ruv-swarm__neural_patterns - Cognitive patternsmcp__ruv-swarm__memory_usage - Memory operationsmcp__ruv-swarm__benchmark_run - Performance benchmarksmcp__ruv-swarm__features_detect - Feature detectionmcp__ruv-swarm__daa_init - Initialize DAAmcp__ruv-swarm__daa_agent_create - Create DAA agentsmcp__ruv-swarm__daa_agent_adapt - Adapt agent behaviormcp__ruv-swarm__daa_workflow_create - Create DAA workflowsmcp__ruv-swarm__daa_workflow_execute - Execute DAA workflowsmcp__ruv-swarm__daa_knowledge_share - Share knowledgemcp__ruv-swarm__daa_learning_status - Learning statusmcp__ruv-swarm__daa_cognitive_pattern - Cognitive patternsmcp__ruv-swarm__daa_meta_learning - Meta-learningmcp__ruv-swarm__daa_performance_metrics - Performance metrics| Agent | Type | Capabilities |
|---|---|---|
| coder | Implementation | Code generation, refactoring, debugging |
| reviewer | Quality Assurance | Code review, best practices, standards |
| tester | Testing | Unit tests, integration tests, TDD |
| researcher | Investigation | Research, analysis, documentation |
| planner | Planning | Project planning, task breakdown |
| Agent | Type | Capabilities |
|---|---|---|
| code-analyzer | Analysis | Code quality, performance, security |
| system-architect | Architecture | System design, patterns, scalability |
| backend-dev | Development | API development, databases, services |
| mobile-dev | Development | React Native, mobile platforms |
| ml-developer | ML/AI | Machine learning, data science |
| api-docs | Documentation | API documentation, OpenAPI specs |
| cicd-engineer | DevOps | CI/CD pipelines, automation |
| performance-benchmarker | Performance | Load testing, optimization |
| production-validator | Validation | Production readiness, deployment |
| task-orchestrator | Coordination | Task management, workflow coordination |
| Agent | Type | Capabilities |
|---|---|---|
| hierarchical-coordinator | Coordination | Queen-led hierarchical swarms |
| mesh-coordinator | Coordination | Peer-to-peer mesh networks |
| adaptive-coordinator | Coordination | Dynamic topology switching |
| collective-intelligence-coordinator | Coordination | Hive-mind intelligence |
| swarm-memory-manager | Memory | Distributed memory coordination |
| consensus-builder | Consensus | Distributed decision making |
| Agent | Type | Capabilities |
|---|---|---|
| github-modes | Integration | Comprehensive GitHub operations |
| pr-manager | Pull Requests | PR creation, review, management |
| issue-tracker | Issues | Issue management, tracking |
| release-manager | Releases | Release coordination, automation |
| code-review-swarm | Code Review | Multi-agent code review |
| repo-architect | Repository | Repository structure, organization |
| workflow-automation | Automation | GitHub Actions, CI/CD |
| sync-coordinator | Synchronization | Multi-repo coordination |
| Agent | Type | Capabilities |
|---|---|---|
| perf-analyzer | Performance | Bottleneck identification, optimization |
| byzantine-coordinator | Consensus | Byzantine fault tolerance |
| raft-manager | Consensus | Raft consensus algorithm |
| gossip-coordinator | Communication | Gossip protocol coordination |
| quorum-manager | Consensus | Quorum-based decisions |
| crdt-synchronizer | Synchronization | CRDT-based data sync |
| security-manager | Security | Security validation, auditing |
| Agent | Type | Capabilities |
|---|---|---|
| sparc-coder | SPARC Implementation | TDD-driven development |
| sparc-coordinator | SPARC Coordination | SPARC workflow management |
const ws = new WebSocket('wss://api.claude-flow.ai/v2/ws');
// Authentication
ws.on('open', () => {
ws.send(JSON.stringify({
type: 'auth',
token: 'your-session-token'
}));
});
// Subscribe to agent events
ws.send(JSON.stringify({
type: 'subscribe',
channels: ['agents', 'swarms', 'tasks', 'memory']
}));
// Agent spawned
{
"type": "agent.spawned",
"data": {
"agentId": "agent_123",
"type": "coder",
"name": "Backend Developer",
"status": "active"
}
}
// Agent status change
{
"type": "agent.status",
"data": {
"agentId": "agent_123",
"status": "busy",
"currentTask": "implement-auth",
"progress": 0.65
}
}
// Swarm coordination event
{
"type": "swarm.coordination",
"data": {
"swarmId": "swarm_456",
"topology": "hierarchical",
"agentCount": 8,
"efficiency": 0.94
}
}
// Task orchestration
{
"type": "swarm.task",
"data": {
"taskId": "task_789",
"assignedAgents": ["agent_123", "agent_456"],
"strategy": "parallel",
"progress": 0.45
}
}
// Memory synchronization
{
"type": "memory.sync",
"data": {
"namespace": "project-alpha",
"entriesSync": 1247,
"compressionRatio": 0.65,
"latency": "12ms"
}
}
# 1. Initialize project with GitHub integration
npx claude-flow@alpha github init
# 2. Set up swarm for development
npx claude-flow@alpha coordination swarm-init \
--topology hierarchical \
--max-agents 8 \
--strategy adaptive
# 3. Spawn development team (concurrent)
npx claude-flow@alpha coordination agent-spawn --type system-architect --name "Lead Architect"
npx claude-flow@alpha coordination agent-spawn --type backend-dev --name "API Developer"
npx claude-flow@alpha coordination agent-spawn --type coder --name "Frontend Dev"
npx claude-flow@alpha coordination agent-spawn --type tester --name "QA Engineer"
npx claude-flow@alpha coordination agent-spawn --type code-analyzer --name "Code Reviewer"
# 4. Store project context in memory
npx claude-flow@alpha memory usage \
--action store \
--key "project/architecture" \
--value "Microservices with event sourcing and CQRS" \
--namespace "development" \
--ttl 86400
# 5. Orchestrate development task
npx claude-flow@alpha coordination task-orchestrate \
--task "Build complete REST API with authentication and testing" \
--strategy parallel \
--priority high
# 6. Monitor swarm performance
npx claude-flow@alpha coordination swarm-status
npx claude-flow@alpha performance report --timeframe 24h --format detailed
# 7. Analyze GitHub repository
npx claude-flow@alpha github repo-analyze \
--repo "myorg/my-project" \
--analysis-type code_quality
# 8. Create workflow for automation
npx claude-flow@alpha workflow create \
--name "full-stack-pipeline" \
--steps '[
{"type": "swarm_init", "topology": "hierarchical"},
{"type": "agent_spawn", "agents": ["architect", "coder", "tester"]},
{"type": "task_orchestrate", "strategy": "parallel"},
{"type": "github_integration", "automate": true}
]'
# 1. Check neural system status
npx claude-flow@alpha neural status
# 2. Train coordination patterns
npx claude-flow@alpha neural train \
--pattern-type coordination \
--training-data "./data/coordination-patterns.json" \
--epochs 100
# 3. Make AI predictions
npx claude-flow@alpha neural predict \
--model-id coordination_model_v1.2 \
--input "complex microservices architecture with event sourcing"
# 4. Analyze cognitive patterns
npx claude-flow@alpha neural patterns \
--pattern convergent \
--analysis detailed
# 1. Store complex project data
npx claude-flow@alpha memory usage \
--action store \
--key "decisions/architecture" \
--value '{
"pattern": "microservices",
"database": "postgres",
"auth": "jwt",
"caching": "redis"
}' \
--namespace "project-alpha" \
--ttl 604800
# 2. Search for related information
npx claude-flow@alpha memory search \
--pattern "microservices|architecture" \
--namespace "project-alpha" \
--limit 10
# 3. Create memory backup
npx claude-flow@alpha memory backup \
--namespace "project-alpha" \
--format compressed
# 4. Analyze memory usage
npx claude-flow@alpha memory analytics \
--timeframe 7d \
--include-compression-stats
# 1. Run comprehensive performance report
npx claude-flow@alpha performance report \
--timeframe 24h \
--format detailed \
--include-recommendations
# 2. Identify bottlenecks
npx claude-flow@alpha bottleneck analyze \
--component swarm_coordination \
--metrics "response_time,throughput,error_rate" \
--severity all
# 3. Optimize swarm topology
npx claude-flow@alpha topology optimize \
--swarm-id "swarm_123" \
--target-efficiency 0.95
# 4. Health check all systems
npx claude-flow@alpha health-check \
--components '["swarm", "neural", "memory", "mcp"]' \
--detailed true
# Agent spawn failure
{
"error": "AGENT_SPAWN_FAILED",
"message": "Maximum agent limit reached",
"details": {
"currentAgents": 8,
"maxAgents": 8,
"swarmId": "swarm_123"
}
}
# Memory operation failure
{
"error": "MEMORY_STORAGE_FULL",
"message": "Memory storage limit exceeded",
"details": {
"usedMemory": "512MB",
"maxMemory": "512MB",
"namespace": "project-alpha"
}
}
# Neural training failure
{
"error": "NEURAL_TRAINING_FAILED",
"message": "Insufficient training data",
"details": {
"requiredSamples": 100,
"providedSamples": 45,
"patternType": "coordination"
}
}
# Retry with backoff
npx claude-flow@alpha coordination agent-spawn \
--type coder \
--retry-attempts 3 \
--retry-delay 1000
# Graceful degradation
npx claude-flow@alpha coordination swarm-init \
--topology hierarchical \
--fallback-topology mesh \
--max-agents 8 \
--min-agents 3
# Error notification
npx claude-flow@alpha hooks post-edit \
--file "error.log" \
--memory-key "errors/$(date +%s)" \
--notify-on-failure true
# Always batch agent operations
# ✅ Good - Single message with multiple spawns
npx claude-flow@alpha coordination agent-spawn --type architect &
npx claude-flow@alpha coordination agent-spawn --type coder &
npx claude-flow@alpha coordination agent-spawn --type tester &
wait
# ❌ Bad - Sequential spawning
npx claude-flow@alpha coordination agent-spawn --type architect
npx claude-flow@alpha coordination agent-spawn --type coder
npx claude-flow@alpha coordination agent-spawn --type tester
# Use namespaces effectively
npx claude-flow@alpha memory usage \
--action store \
--key "config/database" \
--namespace "project-$(date +%Y%m%d)" \
--ttl 86400
# Regular cleanup
npx claude-flow@alpha memory compress \
--namespace "temporary" \
--threshold 0.8
# Monitor before scaling
npx claude-flow@alpha performance report --format summary
npx claude-flow@alpha coordination swarm-scale --target-size 12
# Use appropriate topologies
# Complex tasks -> hierarchical
# Collaborative work -> mesh
# Sequential processing -> ring
# Centralized control -> star
# Hook integration for automation
npx claude-flow@alpha hooks pre-task \
--description "Auto-spawn agents based on task complexity"
npx claude-flow@alpha hooks post-edit \
--file "src/**/*.js" \
--memory-key "code-changes/$(date +%s)"
# Workflow templates for reusability
npx claude-flow@alpha workflow template \
--name "api-development" \
--export "./templates/api-dev-workflow.json"
# Secure authentication
npx claude-flow@alpha github init --secure-mode
npx claude-flow@alpha config set --api-key-encryption enabled
# Resource limits
npx claude-flow@alpha coordination swarm-init \
--max-agents 10 \
--memory-limit "1GB" \
--cpu-limit "4 cores"
# Audit logging
npx claude-flow@alpha log-analysis \
--include-security-events \
--format audit
# Get help for any command
npx claude-flow@alpha --help
npx claude-flow@alpha coordination --help
npx claude-flow@alpha github --help
# Version information
npx claude-flow@alpha --version
Claude-Flow v2.0.0-alpha.59
Intelligent AI Agent Orchestration
</div>