mirror of https://github.com/agent0ai/agent-zero.git synced 2026-05-20 09:25:16 +00:00

History

frdel 5579a3c9e5 Swap button styles for plugin list refresh and install actions Change refresh button from 'confirm' to default style and install button from default to 'confirm' style to better reflect their relative importance and action severity.		2026-03-10 13:57:28 +01:00
..
chat_branching	Standardize plugin titles and bump history_size	2026-03-08 16:14:24 +01:00
code_execution	Use prototype-based context for plugin settings	2026-03-09 21:19:55 +01:00
error_retry	Add tool request validation and plugin change notifications	2026-03-10 13:08:48 +01:00
example_agent	cleanup, simpler toggling logic	2026-02-26 11:15:31 +01:00
infection_check	Use prototype-based context for plugin settings	2026-03-09 21:19:55 +01:00
memory	Add tool request validation and plugin change notifications	2026-03-10 13:08:48 +01:00
plugin_installer	Swap button styles for plugin list refresh and install actions	2026-03-10 13:57:28 +01:00
plugin_scan	marketplace polish; add confirm-dialog extension hook and plugin_scan marketplace note	2026-03-09 11:41:10 +01:00
text_editor	Use prototype-based context for plugin settings	2026-03-09 21:19:55 +01:00
README.md	marketplace polish; add confirm-dialog extension hook and plugin_scan marketplace note	2026-03-09 11:41:10 +01:00

README.md

Agent Zero - Core Plugins

This directory contains the system-level plugins bundled with Agent Zero.

Directory Structure

plugins/: Core system plugins. Reserved for framework updates — do not place custom plugins here.
usr/plugins/: The correct location for all user-developed and custom plugins. This directory is gitignored.

Documentation

For detailed guides on how to create, extend, or configure plugins, refer to:

docs/agents/AGENTS.plugins.md: Full-stack plugin architecture, manifest format, extension points, and Plugin Index submission.
docs/developer/plugins.md: Human-facing developer guide covering the full plugin lifecycle.
AGENTS.md: Main framework guide and backend context.
skills/a0-create-plugin/SKILL.md: Agent-facing authoring workflow (local and community plugins).

What a Plugin Can Provide

Plugins are automatically discovered based on the presence of a plugin.yaml file. Each plugin can contribute:

Backend: API handlers, tools, helpers, and lifecycle extensions
Frontend: HTML/JS UI contributions via core extension breakpoints
Settings: Isolated configuration scoped per-project and per-agent profile
Activation: Global and scoped ON/OFF rules via .toggle-1 and .toggle-0 files, including advanced per-scope switching in the WebUI
Agent profiles: Plugin-distributed subagent definitions under agents/<profile>/agent.yaml

Plugin Manifest

Every plugin requires a plugin.yaml at its root:

title: My Plugin
description: What this plugin does.
version: 1.0.0
settings_sections:
  - agent
per_project_config: false
per_agent_config: false
always_enabled: false

Plugin Initialization (`initialize.py`)

Plugins can include an optional initialize.py at the plugin root for one-time setup such as installing dependencies or downloading models. Users trigger it via the Init button in the Plugin List UI. The script should return 0 on success and print progress messages for user feedback.

The Plugin Index at https://github.com/agent0ai/a0-plugins is the community-maintained registry of plugins available to all Agent Zero users.

To share a plugin with the community:

Create a standalone GitHub repository with the plugin contents at the repo root and the runtime plugin.yaml there.
Fork https://github.com/agent0ai/a0-plugins and add a folder plugins/<your-plugin-name>/ containing a separate index plugin.yaml:

title: My Plugin
description: What this plugin does.
github: https://github.com/yourname/your-plugin-repo
tags:
  - tools

Open a Pull Request. CI validates the submission; a maintainer reviews and merges.

Note: The index plugin.yaml is a different schema from the runtime manifest — it contains only title, description, github, and optional tags. Do not mix them up.

Plugin Marketplace (Coming Soon)

A built-in Plugin Marketplace (always-active plugin) is planned and will allow users to browse the Plugin Index and install community plugins directly from the Agent Zero UI.