ContextQMD
Back to Agent Zero

Plugins

docs/developer/plugins.md

1.141.7 KB
Original Source

Plugins

Most people should start with the practical guide: Create a Small Plugin.

Plugin architecture and source-linked internals live in DeepWiki for Agent Zero. This page stays intentionally small so the repository does not maintain a second plugin manual.

What To Use

GoalStart here
Build your first pluginCreate a Small Plugin
Understand how plugins are loadedDeepWiki
Decide what is safe to publishSharing and Safety
Contribute a plugin upstreamContributing Guide

Minimum Local Plugin

A local plugin usually lives here:

text
/a0/usr/plugins/<plugin_name>/
├── plugin.yaml
├── README.md
└── webui/

The smallest useful plugin.yaml looks like this:

yaml
name: my_plugin
title: My Plugin
description: A short sentence that explains what it does.
version: 1.0.0

Ask Agent Zero to keep the first version small. A tiny plugin that does one visible thing is easier to test, review, and share.

Sharing A Plugin

Before publishing a plugin:

  • keep it in its own public repository;
  • include a clear README.md;
  • include a LICENSE;
  • avoid secrets, local paths, and machine-specific files;
  • explain what the plugin changes and how to remove it.

For Plugin Index submission, use the current instructions in the agent0ai/a0-plugins repository.