Skip to content

Latest commit

 

History

History
512 lines (453 loc) · 41.7 KB

File metadata and controls

512 lines (453 loc) · 41.7 KB

Swarms Examples

This directory contains comprehensive examples demonstrating various capabilities and use cases of the Swarms framework. Each subdirectory focuses on specific aspects of multi-agent systems, single agents, tools, and integrations.

Directory Overview

Multi-Agent Systems

Example Description
multi_agent/ Advanced multi-agent patterns including agent rearrangement, auto swarm builder (ASB), batched workflows, caching, concurrent processing, councils, debates, elections, forest swarms, graph workflows, group chats, heavy swarms, hierarchical swarms, LLM council, majority voting, orchestration examples, paper implementations, sequential workflows, social algorithms, simulations, spreadsheet examples, swarm routing, and utilities
README.md Complete multi-agent examples documentation
duo_agent.py Two-agent collaboration example
tree_swarm_new_updates.py Tree swarm implementation with latest updates
agent_rearrange_examples/ Agent rearrangement and reorganization examples
agent_router_examples/ Agent routing and routing patterns
asb/ Auto Swarm Builder (ASB) examples and implementations
batched_grid_workflow/ Batched grid workflow examples
caching_examples/ Agent caching examples
concurrent_examples/ Concurrent processing and parallel execution examples
council/ Council pattern examples with judge evaluation
council_of_judges/ Council of judges pattern implementations
debate_examples/ Multi-agent debate and discussion examples
election_swarm_examples/ Election and voting swarm examples
exec_utilities/ Execution utilities including uvloop examples
forest_swarm_examples/ Forest swarm and tree-based swarm examples
graphworkflow_examples/ Graph workflow and graph-based processing examples
groupchat/ Asynchronous self-selecting group chat examples where agents independently decide whether to respond
heavy_swarm_examples/ Heavy swarm implementations for complex tasks
hiearchical_swarm/ Hierarchical swarm structures and patterns
hscf/ Hierarchical Swarm Control Framework examples
llm_council_examples/ LLM Council collaboration patterns
majority_voting/ Majority voting and consensus examples
mar/ Multi-agent rearrangement examples
moa_examples/ Mixture of Agents (MOA) examples
orchestration_examples/ Agent orchestration and coordination examples
paper_implementations/ Research paper implementations
sequential_workflow/ Sequential workflow examples
simulations/ Multi-agent simulation examples
social_algorithms_examples/ Social algorithm patterns and implementations
spreadsheet_examples/ Spreadsheet-based agent examples
swarm_router/ Swarm routing and routing patterns
swarmarrange/ Swarm arrangement examples
swarms_api_examples/ Swarms API integration examples
utils/ Multi-agent utility functions

Single Agent Systems

Example Description
single_agent/README.md Full index of single-agent examples
getting_started/ First runs: minimal agent, interactive mode, onboarding
getting_started/simple_agent.py Basic single agent example
getting_started/interactive.py Interactive REPL-style agent
capabilities/tools/ Tool integration: MCP, Exa search, LiteLLM, multi-tool, Solana, structured outputs, browser agents
capabilities/skills/ Agent skills: dynamic, custom, and pre-built (code review, data viz, financial analysis)
capabilities/rag/ Retrieval-augmented generation with Pinecone and Qdrant
capabilities/vision/ Vision and multimodal agents, batch image processing
capabilities/streaming/ Token streaming, streaming with tools and loops
capabilities/prompt_caching/ Provider-side prompt caching (Anthropic, OpenAI)
reasoning/ Reasoning agents: judges, consistency, iterative, reasoning duo/router
autonomy/autonomous_agents/ Autonomous loops, sub-agents, run_bash looper
autonomy/handoffs/ Agent-to-agent handoffs
integrations/marketplace/ Marketplace prompts and publishing agents to the marketplace
integrations/external_agents/ Bridges to external agent systems
demos/ Applied demos: insurance, persistent legal agent
utils/ Config, output formats, autosaving, prompt transforms
Model/provider examples (Azure, Claude, DeepSeek, Mistral, OpenAI, Qwen, …) Moved to models/ — see models/README.md

Tools & Integrations

Example Description
tools/ Tool integration examples including agent-as-tools, base tool implementations, browser automation, Claude integration, Exa search, Firecrawl, multi-tool usage, and Stagehand integration
README.md Complete tools examples documentation
agent_as_tools.py Using agents as tools
browser_use_as_tool.py Browser automation tool
browser_use_demo.py Browser automation demonstration
claude_as_a_tool.py Claude model integration as a tool
exa_search_agent.py Exa search integration
exa_search_agent_quant.py Exa search with quantitative analysis
exa_search_test.py Exa search testing examples
firecrawl_agents_example.py Firecrawl integration
base_tool_examples/ Base tool implementation examples
base_tool_examples.py Base tool examples
conver_funcs_to_schema.py Convert functions to schema
convert_basemodels.py Convert base models
exa_search_test.py Exa search test
example_usage.py Base tool usage example
schema_validation_example.py Schema validation example
test_anthropic_specific.py Anthropic-specific test
test_base_tool_comprehensive_fixed.py Comprehensive base tool test (fixed)
test_base_tool_comprehensive.py Comprehensive base tool test
test_function_calls_anthropic.py Function calls test (Anthropic)
test_function_calls.py Function calls test
multii_tool_use/ Multi-tool usage examples
stagehand/ Stagehand UI automation
1_stagehand_wrapper_agent.py Stagehand wrapper agent
2_stagehand_tools_agent.py Stagehand tools agent
3_stagehand_mcp_agent.py Stagehand MCP agent
4_stagehand_multi_agent_workflow.py Stagehand multi-agent workflow
tests/ Stagehand tests
test_stagehand_integration.py Stagehand integration test
test_stagehand_simple.py Simple Stagehand test

API & Protocols

Swarms API

Example Description
swarms_api/ Swarms API usage examples including agent overview, batch processing, client integration, team examples, analysis, and rate limiting
README.md API examples documentation
agent_overview.py Agent overview and listing examples
client_example.py API client example
batch_example.py Batch processing example
hospital_team.py Hospital management team simulation
legal_team.py Legal team collaboration example
icd_ten_analysis.py ICD-10 medical code analysis
rate_limits.py Rate limiting and throttling examples

Model Context Protocol (MCP)

Example Description
mcp/ Model Context Protocol (MCP) integration examples, split into agents / servers / client
README.md Start here — which folder to use and a 30-second example
agents/ Give an agent tools from an MCP server
01_deepwiki_repo_qa.py Quickstart: agent + DeepWiki, no API key needed
02_gitmcp_repo_docs.py Agent + GitMCP for any public repo's docs/code
03_microsoft_learn_docs.py Agent + Microsoft Learn official docs
04_multi_server_agent.py One agent, two MCP servers at once
05_exa_web_search.py Agent + Exa web search (free API key)
FREE_MCP_SERVERS.md Catalog of real public MCP servers
deepwiki_minimal.py Smallest possible mcp_url agent
mcp_connection_object.py MCPConnection with headers, auth, timeout
multi_mcp_urls.py mcp_urls=[...] for several servers
multi_mcp_walkthrough.py Longer annotated multi-server walkthrough
mcp_with_local_tools.py MCP tools plus your own Python tool schemas
tools_list_dictionary.py The raw tool-schema format MCP tools become
finance_agent_mcp.py Realistic finance agent backed by MCP
servers/ Build an MCP server agents connect to
crypto_price_server.py FastMCP server exposing crypto prices
okx_crypto_server.py OKX price server (port 8001)
agent_as_tool_server.py Expose a whole swarms Agent as one MCP tool
streamable_http_server.py Stateful vs stateless streamable-HTTP config
client/ Call MCP directly with MCPManager, no Agent
01_list_tools.py Discover a server's tools; OpenAI vs MCP schema format
02_call_tool.py Call one tool by name, sync and async
03_execute_llm_tool_calls.py Execute the tool calls in an LLM response
04_multi_server.py Several servers, automatic per-tool routing
05_auth_and_config.py API keys, bearer tokens, headers, env secrets, OAuth
06_remote_agents.py Spawn and run agents on a remote MCP server

Agents over Protocol (AOP)

Example Description
aop_examples/ Agents over Protocol (AOP) examples demonstrating MCP server setup, agent discovery, client interactions, queue-based task submission, medical AOP implementations, and utility functions
README.md AOP examples documentation
server.py AOP server implementation
client/ AOP client examples and agent discovery including cluster, queue, raw client, and task examples
aop_cluster_example.py AOP cluster example
aop_queue_example.py AOP queue-based task submission
aop_raw_client_code.py Raw AOP client implementation
aop_raw_task_example.py Raw AOP task example
example_new_agent_tools.py New agent tools example
get_all_agents.py Get all available agents
list_agents_and_call_them.py List and call agents example
discovery/ Agent discovery examples including communication and discovery testing
example_agent_communication.py Agent communication example
test_aop_discovery.py AOP discovery testing
simple_discovery_example.py Simple discovery example
example_aop_discovery.py AOP discovery example
medical_aop/ Medical AOP implementations
server.py Medical AOP server
client.py Medical AOP client
utils/ AOP utility functions
network_management_example.py Network management example
comprehensive_aop_example.py Comprehensive AOP example
persistence_management_example.py Persistence management example
network_error_example.py Network error handling example
persistence_example.py Persistence example

Advanced Capabilities

Example Description
reasoning_agents/ Advanced reasoning capabilities including agent judge evaluation systems, O3 model integration, mixture of agents (MOA) sequential examples, and reasoning agent router examples
README.md Reasoning agents documentation
moa_seq_example.py MOA sequential example
agent_judge_examples/ Agent judge evaluation systems
example1_basic_evaluation.py Basic evaluation example
example2_technical_evaluation.py Technical evaluation example
example3_creative_evaluation.py Creative evaluation example
reasoning_agent_router_examples/ Reasoning agent router examples
agent_judge_example.py Agent judge example
gkp_agent_example.py GKP agent example
ire_example.py IRE example
reasoning_duo_example.py Reasoning duo example
reflexion_agent_example.py Reflexion agent example
self_consistency_example.py Self-consistency example
voice_agents/ Voice and speech-enabled agent examples including agent speech, agent with speech, debate with speech, Google Calendar integration, hierarchical speech swarm, and autonomous agent with speech
README.md Voice agents documentation
agent_speech.py Agent with speech capabilities
agent_with_speech.py Speech-enabled agent implementation
debate_with_speech.py Multi-agent debate with speech capabilities
google_calendar_agent.py Google Calendar integration with voice agent
hiearchical_speech_swarm.py Hierarchical speech swarm implementation
run_auto_agent_with_speech.py Autonomous agent with terminal access and streaming TTS

Marketplace

Example Description
marketplace/ Swarms marketplace prompt integration examples for using pre-built prompts from the marketplace
zia_agent.py Zia agent implementation using marketplace prompts
single_agent/integrations/marketplace/ Single agent marketplace examples including marketplace prompt integration and quant trader agent
marketplace_prompt_example.py Example of using marketplace prompts with agents
quant_trader_agent.py Quantitative trader agent using marketplace prompts

Guides & Tutorials

Example Description
guides/ Comprehensive guides and tutorials including demos, generation length blog, geo guesser agent, graph workflow guide, hackathon examples, hierarchical marketing team, nano banana Jarvis agent, smart database, web scraper agents, workshops, x402 examples, and workshop examples (840_update, 850_workshop)
README.md Guides documentation
hiearchical_marketing_team.py Hierarchical marketing team example
840_update/ Update examples from version 8.4.0 including agent rearrange, auto swarm builder, and fallback examples
850_workshop/ Workshop examples from version 8.5.0 including AOP, MOA, peer review, and concurrent examples
880_update_changelog_examples/ Changelog examples showcasing new features including marketplace integration, multi-agent structures, workflow orchestration, voice agents, evaluation & debate, routing, and autosaving
changelog_890/ Changelog examples from January 2026 release including dynamic skills loader, autonomous agent loop, agent handoffs, API key validation, max loops parameter, multi-tool agent tutorial, hierarchical voice agent, and agent rearrange patterns
mem0/ Mem0 integration examples for memory management with Swarms
demos/ Various demonstration examples including apps, crypto, finance, insurance, legal, medical, real estate, science, and synthetic data
fairy_swarm/ Fairy swarm examples and implementations
generation_length_blog/ Long-form content generation examples
geo_guesser_agent/ Geographic guessing agent examples
graphworkflow_guide/ Comprehensive graph workflow guide and examples
hackathon_judge_agent/ Hackathon judging agent examples
hackathons/ Hackathon project examples
nano_banana_jarvis_agent/ Nano banana Jarvis agent with image generation
smart_database/ Smart database examples
voice_agents/ Voice agent examples with speech capabilities
web_scraper_agents/ Web scraper agent examples
workshops/ Workshop examples
x402_examples/ X402 protocol examples
deployment/ Deployment strategies: cron jobs and FastAPI examples
v9_examples/ V9 autonomous looper examples (autonomous_looper, tools, sub-agents)

Deployment

Example Description
guides/deployment/ Deployment strategies and patterns including cron job implementations and FastAPI deployment examples
README.md Deployment documentation
fastapi/ FastAPI deployment examples
cron_job_examples/ Cron job examples

Utilities

Example Description
utils/ Utility functions and helper implementations including agent loader, communication examples, concurrent wrappers, miscellaneous utilities, and telemetry
README.md Utils documentation
agent_loader/ Agent loading utilities
communication_examples/ Agent communication patterns including DuckDB, Pulsar, Redis, and SQLite
fetch_prompt.py Prompt fetching utilities
litellm_connect_issue.py LiteLLM connection issue examples
litellm_network_error_handling.py LiteLLM network error handling
misc/ Miscellaneous utility functions including AOP, conversation, CSV agents, and visualization
agent_map_test.py Agent map test
conversation_simple.py Simple conversation example
conversation_test_truncate.py Conversation truncate test
conversation_test.py Conversation test
csvagent_example.py CSV agent example
dict_to_table.py Dictionary to table conversion
swarm_matcher_example.py Swarm matcher example
test_load_conversation.py Load conversation test
visualizer_test.py Visualizer test
aop/ AOP utility examples
client.py AOP client utility
test_aop.py AOP test
telemetry/ Telemetry and monitoring utilities

User Interface

Example Description
ui/ User interface examples and implementations including chat interfaces
README.md UI examples documentation
chat.py Chat interface example

Command Line Interface

Example Description
cli/ CLI command examples demonstrating all available Swarms CLI features including setup, agent management, multi-agent architectures, and utilities
README.md CLI examples documentation
01_setup_check.sh Environment setup verification
02_onboarding.sh User onboarding process
03_get_api_key.sh API key retrieval
04_check_login.sh Login status verification
05_create_agent.sh Create custom agents
06_run_agents_yaml.sh Run agents from YAML configuration
07_load_markdown.sh Load markdown configurations
08_llm_council.sh LLM Council collaboration
09_heavy_swarm.sh HeavySwarm complex analysis
10_autoswarm.sh Auto swarm builder examples
11_features.sh Feature demonstration
12_help.sh Help and documentation
13_auto_upgrade.sh Automatic upgrade process
14_book_call.sh Book a call functionality
run_all_examples.sh Run all CLI examples

Quick Start

Use Case Example
New to Swarms? Start with single_agent/simple_agent.py for basic concepts
Want to use the CLI? Check out cli/ for all CLI command examples
Want multi-agent workflows? Check out multi_agent/duo_agent.py
Need tool integration? Explore tools/agent_as_tools.py
Interested in AOP? Try aop_examples/client/example_new_agent_tools.py for agent discovery
Want to see social algorithms? Check out multi_agent/social_algorithms_examples/
Looking for guides? Visit guides/ for comprehensive tutorials
Need RAG? Try single_agent/rag/ for RAG examples
Want reasoning agents? Check out reasoning_agents/ for reasoning agent examples
Interested in marketplace prompts? Explore marketplace/ for marketplace prompt integration examples
Want voice/speech capabilities? Check out voice_agents/ for speech-enabled agent examples
Interested in agent skills? Explore single_agent/capabilities/skills/ for dynamic skills
Want autonomous agents? Check out single_agent/autonomy/autonomous_agents/ for full autonomy examples
Need agent handoffs? See single_agent/handoffs/ for handoff patterns
Looking for latest features? Visit guides/changelog_890/ for January 2026 release examples

Key Examples by Category

Multi-Agent Patterns

Example Description
Duo Agent Two-agent collaboration
Tree Swarm Tree swarm with latest updates
Agent Rearrange Agent rearrangement patterns
Agent Router Agent routing implementations
Agent GRPO Agent GRPO examples for math and physics problems
Auto Swarm Builder Auto Swarm Builder (ASB) examples
Batched Grid Workflow Batched grid workflow patterns
Concurrent Processing Concurrent and parallel execution
Council Council pattern with judge evaluation
Council of Judges Council of judges implementations
Debates Multi-agent debate examples
Election Swarm Election and voting swarms
Forest Swarm Forest and tree-based swarms
Hierarchical Swarm Hierarchical agent structures
Heavy Swarm Heavy swarm for complex tasks
Group Chat Asynchronous self-selecting group chat where agents choose when to reply
Graph Workflow Graph-based workflows
LLM Council LLM Council collaboration
Majority Voting Majority voting and consensus
Mixture of Agents Mixture of Agents (MOA) examples
Orchestration Agent orchestration patterns
Sequential Workflow Sequential workflow examples
Simulations Multi-agent simulations
Social Algorithms Various social algorithm patterns
Spreadsheet Examples Spreadsheet-based agents
Swarm Router Swarm routing patterns

Single Agent Examples

Example Description
Simple Agent Basic agent setup
Auto Agent Auto agent implementation
Agent Skills Dynamic skills loader and custom skill examples
Autonomous Agents Full autonomy examples with marketplace integration
Agent Handoffs Agent handoff patterns and examples
Marketplace Integration Marketplace prompt integration examples
Reasoning Agents Advanced reasoning patterns including consistency, GPK, iterative, and reasoning duo
Vision Agents Vision and multimodal capabilities
RAG Agents Retrieval augmented generation
External Agents External agent integrations
Onboarding Agent onboarding examples
Tools Integration Comprehensive tool integration examples
Voice Agents Speech-enabled agent examples

Tool Integrations

Example Description
Agent as Tools Using agents as tools
Browser Automation Browser control
Browser Demo Browser automation demonstration
Claude as Tool Claude model as a tool
Exa Search Search integration
Exa Search Quant Exa search with quantitative analysis
Firecrawl Firecrawl web scraping integration
Stagehand UI automation
Base Tools Base tool implementation examples
Multi-Tool Use Multi-tool usage examples

Model Integration Examples

Example Description
OpenAI OpenAI models
Claude Claude models
DeepSeek DeepSeek models
DeepSeek Groq DeepSeek with Groq integration
Azure Azure OpenAI
Mistral Mistral models
O3 O3 model integration
Qwen Qwen model integration
Ollama Local Ollama and other providers via LiteLLM—see docs and models/

Marketplace Examples

Example Description
Marketplace Prompt Using marketplace prompts with agents
Quant Trader Agent Quantitative trader agent with marketplace prompts
Zia Agent Zia agent with marketplace prompt integration

CLI Examples

Example Description
Setup Check Verify environment setup
Onboarding User onboarding process
Get API Key API key retrieval
Check Login Login status verification
Create Agent Create custom agents via CLI
Run Agents YAML Run agents from YAML configuration
Load Markdown Load markdown configurations
LLM Council Run LLM Council collaboration
HeavySwarm Run HeavySwarm for complex tasks
AutoSwarm Auto swarm builder examples
Features Feature demonstration
Help Help and documentation
Auto Upgrade Automatic upgrade process
Book Call Book a call functionality
Research Agent Research agent example
Run All Examples Run all CLI examples

MISC

Category Example Description Link
Basic Examples Basic Agent Simple agent setup and usage Basic Agent
Basic Examples Agent with Tools Using agents with various tools Agent with Tools
Basic Examples Agent with Structured Outputs Working with structured data outputs Structured Outputs
Basic Examples Agent with MCP Integration Model Context Protocol integration MCP Integration
Basic Examples Vision Processing Agents with image processing capabilities Vision Processing
Basic Examples Multiple Images Working with multiple images Multiple Images
Basic Examples Vision and Tools Combining vision with tool usage Vision and Tools
Basic Examples Agent Streaming Real-time agent output streaming Agent Streaming
Basic Examples Agent Output Types Different output formats and types Output Types
Basic Examples Gradio Chat Interface Building interactive chat interfaces Gradio UI
Model Providers Model Providers Overview Complete guide to supported models Model Providers
Model Providers OpenAI OpenAI model integration OpenAI Examples
Model Providers Anthropic Claude model integration Anthropic Examples
Model Providers Groq Groq model integration Groq Examples
Model Providers Cohere Cohere model integration Cohere Examples
Model Providers DeepSeek DeepSeek model integration DeepSeek Examples
Model Providers Ollama Local Ollama model integration Ollama Examples
Model Providers OpenRouter OpenRouter model integration OpenRouter Examples
Model Providers XAI XAI model integration XAI Examples
Model Providers Llama4 Llama4 model integration Llama4 Examples
Multi-Agent Architecture HierarchicalSwarm Hierarchical agent orchestration HierarchicalSwarm Examples
Multi-Agent Architecture Hybrid Hierarchical-Cluster Swarm Advanced hierarchical patterns HHCS Examples
Multi-Agent Architecture GroupChat Multi-agent conversations GroupChat Examples
Multi-Agent Architecture Sequential Workflow Step-by-step agent workflows Sequential Examples
Multi-Agent Architecture SwarmRouter Universal swarm orchestration SwarmRouter Examples
Multi-Agent Architecture MultiAgentRouter Minimal router example MultiAgentRouter Examples
Multi-Agent Architecture ConcurrentWorkflow Parallel agent execution Concurrent Examples
Multi-Agent Architecture Mixture of Agents Expert agent collaboration MoA Examples
Multi-Agent Architecture Unique Swarms Specialized swarm patterns Unique Swarms
Multi-Agent Architecture Agents as Tools Using agents as tools in workflows Agents as Tools
Multi-Agent Architecture Aggregate Responses Combining multiple agent outputs Aggregate Examples
Multi-Agent Architecture Interactive GroupChat Real-time agent interactions Interactive GroupChat
Deployment Solutions Agent Orchestration Protocol (AOP) Deploy agents as distributed services with discovery and management AOP Reference
Applications Advanced Research System Multi-agent research system inspired by Anthropic's research methodology AdvancedResearch
Applications Hospital Simulation Healthcare simulation system using multi-agent architecture HospitalSim
Applications Browser Agents Web automation with agents Browser Agents
Applications Medical Analysis Healthcare applications Medical Examples
Applications Finance Analysis Financial applications Finance Examples
Cookbook & Templates Examples Overview Complete examples directory Examples Index
Cookbook & Templates Cookbook Index Curated example collection Cookbook
Cookbook & Templates Paper Implementations Research paper implementations Paper Implementations
Cookbook & Templates Templates & Applications Reusable templates Templates

Documentation

Each subdirectory contains its own README.md file with detailed descriptions and links to all available examples. Click on any folder above to explore its specific examples and use cases.

Related Resources

Contributing

Found an interesting example or want to add your own? Check out our contributing guidelines and feel free to submit pull requests with new examples or improvements to existing ones.


This examples directory is continuously updated with new patterns, integrations, and use cases. Check back regularly for the latest examples!