agent-zero/docs

Agent Zero Documentation

Welcome to the Agent Zero documentation hub. Whether you're getting started or diving deep into the framework, you'll find comprehensive guides below.

Quick Start

• Quickstart Guide: Get up and running in 5 minutes with Agent Zero.
• Installation Guide: Detailed setup instructions for all platforms (or update your installation).
• VPS Deployment: Deploy Agent Zero on a remote server.
• Development Setup: Set up a local development environment.

User Guides

• Usage Guide: Comprehensive guide to Agent Zero's features and capabilities.
• Projects Tutorial: Learn to create isolated workspaces with dedicated context and memory.
• API Integration: Add external APIs without writing code.
• MCP Setup: Configure Model Context Protocol servers.
• A2A Setup: Enable agent-to-agent communication.
• Troubleshooting: Solutions to common issues and FAQs.

Developer Documentation

• Architecture Overview: Understand Agent Zero's internal structure and components.
• Plugins: Build plugins with plugin.yaml, scoped settings, and activation toggles.
• Extensions: Create custom extensions to extend functionality.
• Connectivity: Connect to Agent Zero from external applications.
• WebSockets: Real-time communication infrastructure.
• MCP Configuration: Advanced MCP server configuration.
• Notifications: Notification system architecture and setup.
• Contributing Skills: Create and share agent skills.
• Contributing Guide: Contribute to the Agent Zero project.

Community & Support

• Join the Community: Connect with other users on Discord to discuss ideas, ask questions, and collaborate.
• Share Your Work: Show off your Agent Zero creations and workflows in the Show and Tell area.
• Report Issues: Use the GitHub issue tracker to report bugs or suggest features.
• Follow Updates: Subscribe to the YouTube channel for tutorials and release videos.

---

Table of Contents

• Quick Start

  • Quickstart Guide
  • Installation Guide
    • Step 1: Install Docker Desktop
      • Windows Installation
      • macOS Installation
      • Linux Installation
    • Step 2: Run Agent Zero
      • Pull Docker Image
      • Map Folders for Persistence
      • Run the Container
      • Access the Web UI
    • Step 3: Configure Agent Zero
      • Settings Configuration
      • Agent Configuration
      • Chat Model Settings
      • API Keys
      • Authentication
    • Choosing Your LLMs
    • Installing Ollama (Local Models)
    • Using on Mobile Devices
    • How to Update Agent Zero
  • VPS Deployment
  • Development Setup

• User Guides

  • Usage Guide
    • Basic Operations
    • Tool Usage
    • Projects
      • What Projects Provide
      • Creating Projects
      • Project Configuration
      • Activating Projects
      • Common Use Cases
    • Tasks & Scheduling
      • Task Types
      • Creating Tasks
      • Task Configuration
      • Integration with Projects
    • Secrets & Variables
    • Remote Access via Tunneling
    • Voice Interface
    • Memory Management
    • Backup & Restore
  • Projects Tutorial
  • API Integration
  • MCP Setup
  • A2A Setup
  • Troubleshooting

• Developer Documentation

  • Architecture Overview
    • System Architecture
    • Runtime Architecture
    • Implementation Details
    • Core Components
      • Agents
      • Tools
      • Memory System
      • Prompts
      • Knowledge
      • Skills
      • Extensions
  • Plugins
  • Extensions
  • Connectivity
  • WebSockets
  • MCP Configuration
  • Notifications
  • Contributing Skills
  • Contributing Guide

---

Your journey with Agent Zero starts now!

Ready to dive in? Start with the Quickstart Guide for the fastest path to your first chat, or follow the Installation Guide for a detailed setup walkthrough.