vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/agents/AGENTS.md
frdel e138e33ca9 Add file-level DOX docs & update AGENTS indexes 
Add comprehensive file-level DOX documentation across the repo and update directory AGENTS.md indexes. Many new `*.py.dox.md` files were added under api, helpers, tools, plugins, extensions, webui, and other dirs to document endpoint purpose, ownership, runtime contracts, work guidance, and verification. Several AGENTS.md files were created or updated (agents profiles, api, docker, extensions, helpers, plugins, skills, webui components, etc.) to list child DOX files and clarify documentation/work guidance. Also add example and bundled profile DOX files (agent0, default, developer, hacker, researcher) and minor updates to helpers/dirty_json.py and its tests. These changes improve on-disk documentation coverage and establish the convention that each direct runtime file should have a matching `*.dox.md` describing its contracts and verification steps.
2026-06-08 12:41:53 +02:00

2 KiB
Raw Blame History

Agent Profiles DOX

Purpose

  • Own bundled agent profiles, profile-specific prompts, and profile-local tools.
  • Keep profile behavior understandable without requiring edits to core framework prompts.

Ownership

  • Each direct profile directory owns its agent.yaml, optional prompts/, optional tools/, and optional extensions/.
  • _example/ demonstrates profile layout and should stay suitable as a reference.
  • User-created local profiles belong under usr/agents/, not here, unless they are intended to ship with the product.

Local Contracts

  • agent.yaml is the profile entry point and must stay valid YAML.
  • Profile prompt overrides should be narrow and named to match the core prompt they extend or replace.
  • Profile-local tools must follow the same Tool contract as root tools/.
  • Do not put secrets, provider API keys, local paths, or user-specific settings in bundled profiles.

Work Guidance

  • Prefer small profile-specific prompt files over duplicating large core prompts.
  • Keep examples generic and runnable in a clean checkout.
  • When changing profile behavior, check how the WebUI profile picker and backend profile loader discover profiles.

Verification

  • Run pytest or targeted tests covering profile loading when changing agent.yaml structure or profile discovery.
  • Manually inspect YAML validity for changed profiles if no targeted test exists.

Child DOX Index

Direct child DOX files:

Child Scope
_example/AGENTS.md Reference profile demonstrating profile-local prompts, tools, and extensions.
agent0/AGENTS.md Main user-facing Agent Zero profile metadata.
default/AGENTS.md Base profile metadata and inherited prompt specifics.
developer/AGENTS.md Software development specialist profile.
hacker/AGENTS.md Cyber security and penetration testing specialist profile.
researcher/AGENTS.md Research, data analysis, and reporting specialist profile.