Skip to content

README.md

Latest commit

 

History

History
323 lines (247 loc) · 8.57 KB

README.md

File metadata and controls

323 lines (247 loc) · 8.57 KB

AutoIT Swarm Documentation Index

Welcome to the AutoIT Swarm documentation. This index provides a complete list of all available documentation.

Last Updated: March 2026
Version: 2.0

📚 Documentation Categories

Getting Started

Document Description For
Getting Started Quick start with examples New users
Installation Detailed setup instructions First-time installers
Features Complete feature overview All users

Configuration

Document Description For
Configuration Guide Complete configuration reference Administrators
LLM Providers Multi-LLM provider setup All users
Agent Tools NEW MCP, web search, tools Advanced users
Webhooks Incoming/outgoing webhook setup Integrators

Usage & Operation

Document Description For
Dashboard Guide Web UI and API documentation All users
Task Management Task control and monitoring Operators
HITL Guide Human-in-the-Loop escalation Reviewers
Agents Guide Agent roles and capabilities All users

Technical Reference

Document Description For
Architecture Overview System design and flow Developers
API Reference Complete REST API reference Developers
Tech Stack Technologies and dependencies Developers
Docker Guide Container deployment DevOps

Support

Document Description For
Troubleshooting Common issues and solutions All users

🚀 Quick Navigation

For New Users

  1. Getting Started - Start here
  2. Installation - Set up the system
  3. Dashboard Guide - Learn the interface
  4. Features - Explore capabilities

For Administrators

  1. Configuration Guide - Full configuration
  2. Agent Tools - MCP and tools setup
  3. LLM Providers - Configure LLM
  4. Troubleshooting - Resolve issues

For Developers

  1. Architecture Overview - System design
  2. API Reference - Integration guide
  3. Agent Tools - Tool development
  4. Tech Stack - Technology details

For Integrators

  1. Agent Tools - Webhooks and tools
  2. API Reference - REST API documentation
  3. Webhooks - Webhook setup
  4. Dashboard Guide - API examples

📋 Document Summaries

Getting Started

Quick start guide covering:

  • Prerequisites and installation
  • Starting the system
  • Usage examples (CLI, Web, API, Webhook)
  • Example workflows
  • Configuration basics
  • Task monitoring
  • File generation access

Configuration Guide

Complete configuration reference:

  • LLM provider settings (6 providers)
  • Agent configuration (12 agents)
  • HITL settings
  • Output destinations (file, email, webhook)
  • Webhook configuration
  • Task board settings
  • Memory/vector store
  • Logging configuration (daily rotation)
  • Environment variables
  • Security best practices

Agent Tools - NEW

MCP and external tools documentation:

  • Built-in tools (web_search, web_fetch, document_search, etc.)
  • MCP server configuration
  • Agent capabilities (Internet, MCP, Documents)
  • File generation (15+ formats)
  • Document retrieval
  • Security considerations
  • API endpoints for tools

Dashboard Guide

Web interface and API documentation:

  • Dashboard pages (6 pages)
  • Stats cards and widgets
  • Task management features
  • Agent activity display
  • HITL review panel
  • Settings UI (6 tabs)
  • Projects page (card/list view)
  • REST API endpoints
  • WebSocket events

Features

Comprehensive feature documentation:

  • Multi-LLM provider support
  • 12 specialized agents (+ custom)
  • MCP and external tools
  • File generation (15+ formats)
  • Webhook integration
  • Task management
  • HITL system
  • Monitoring & observability
  • Security features
  • Persistence options
  • New features in v2.0

Troubleshooting

Common issues and solutions:

  • Quick diagnostics
  • LLM provider issues
  • Task processing issues
  • Dashboard problems
  • Webhook troubleshooting
  • Agent issues
  • Database/memory issues
  • Docker deployment issues
  • Performance problems
  • Security concerns

Architecture Overview

System design documentation:

  • High-level architecture
  • Agent architecture
  • Task lifecycle
  • Message queue system
  • Shared memory
  • HITL integration
  • Data flow diagrams

API Reference

Complete REST API documentation:

  • System endpoints
  • Task endpoints
  • Agent endpoints (including config)
  • MCP endpoints
  • HITL endpoints
  • Webhook endpoints
  • WebSocket events
  • Request/response examples

HITL Guide

Human-in-the-Loop documentation:

  • Escalation triggers (8 triggers)
  • HITL modes (Web, CLI, Email, Webhook)
  • Decision interface
  • Configuration options
  • Best practices

Task Management

Task control and monitoring:

  • Task lifecycle
  • Status definitions
  • Progress tracking
  • Pause/resume controls
  • Timeout handling
  • Retry logic
  • Task dependencies
  • Infinite loop prevention

Agents Guide

Agent roles and capabilities:

  • 12 built-in agents
  • Marketing agent (new)
  • Dynamic sub-agents
  • Agent communication
  • Agent configuration
  • Custom agent creation

Installation

Setup instructions:

  • System requirements
  • Python installation
  • Ollama setup
  • Cloud provider setup
  • Docker installation
  • Configuration
  • Verification

Tech Stack

Technology documentation:

  • Python libraries
  • LLM providers
  • Vector stores
  • Message queues
  • Web framework
  • Dependencies

Docker Guide

Container deployment:

  • Docker setup
  • Docker Compose
  • Volume configuration
  • Network setup
  • GPU support
  • Production deployment

🔗 External Resources

LLM Providers

Web Search Providers

Technologies Used

🆕 What's New in v2.0

New Features

  1. Marketing Agent - 12th agent for marketing and branding
  2. Projects Page - Card/list view toggle, deliverables section
  3. File Generation - 15+ formats with auto-detection
  4. MCP Client - External tool connections
  5. Web Search - Tavily/Serper integration
  6. Agent Editor - Configure capabilities per agent
  7. Daily Log Rotation - Organized log files by date
  8. Settings Enhancements - Agents tab, capability toggles
  9. Infinite Loop Prevention - Multiple safeguards
  10. API Timeouts - 5-second timeout with fallbacks

Updated Documentation

  • AGENT_TOOLS.md - New document for MCP and tools
  • GETTING_STARTED.md - Added file generation, agent config examples
  • FEATURES.md - Complete rewrite with v2.0 features
  • CONFIGURATION_GUIDE.md - Added MCP, agent capabilities
  • DASHBOARD_GUIDE.md - Added Projects page, Settings tabs

📞 Support

Getting Help

  1. Check the Troubleshooting Guide
  2. Review relevant documentation
  3. Search GitHub Issues
  4. Open a new issue with details

Contributing

  • Report bugs via GitHub Issues
  • Submit pull requests for fixes
  • Suggest features via Issues
  • Improve documentation

Documentation Version: 2.0
Last Updated: March 2026