main
md 45 lines 2.19 KB
Rendered Raw
1 # Agent Profiles DOX
2
3 ## Purpose
4
5 - Own bundled agent profiles, profile-specific prompts, and profile-local tools.
6 - Keep profile behavior understandable without requiring edits to core framework prompts.
7
8 ## Ownership
9
10 - Each direct profile directory owns its `agent.yaml`, optional `prompts/`, optional `tools/`, and optional `extensions/`.
11 - `_example/` demonstrates profile layout, is not selectable, and should stay
12 suitable as a reference.
13 - User-created local profiles belong under `usr/agents/`, not here, unless they are intended to ship with the product.
14
15 ## Local Contracts
16
17 - `agent.yaml` is the profile entry point and must stay valid YAML.
18 - Profile prompt overrides should be narrow and named to match the core prompt they extend or replace.
19 - Profile-local tools must follow the same `Tool` contract as root `tools/`.
20 - Do not put secrets, provider API keys, local paths, or user-specific settings in bundled profiles.
21
22 ## Work Guidance
23
24 - Prefer small profile-specific prompt files over duplicating large core prompts.
25 - Keep examples generic and runnable in a clean checkout.
26 - When changing profile behavior, check how the WebUI profile picker and backend profile loader discover profiles.
27
28 ## Verification
29
30 - Run `pytest` or targeted tests covering profile loading when changing `agent.yaml` structure or profile discovery.
31 - Manually inspect YAML validity for changed profiles if no targeted test exists.
32
33 ## Child DOX Index
34
35 Direct child DOX files:
36
37 | Child | Scope |
38 | --- | --- |
39 | [_example/AGENTS.md](_example/AGENTS.md) | Reference profile demonstrating profile-local prompts, tools, and extensions. |
40 | [agent0/AGENTS.md](agent0/AGENTS.md) | Main user-facing Agent Zero profile metadata. |
41 | [default/AGENTS.md](default/AGENTS.md) | Base profile metadata and inherited prompt specifics. |
42 | [developer/AGENTS.md](developer/AGENTS.md) | Software development specialist profile. |
43 | [hacker/AGENTS.md](hacker/AGENTS.md) | Cyber security and penetration testing specialist profile. |
44 | [researcher/AGENTS.md](researcher/AGENTS.md) | Research, data analysis, and reporting specialist profile. |
45 | [tiny-local/AGENTS.md](tiny-local/AGENTS.md) | Small/local model profile with an action-first communication prompt. |