mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-07-09 17:08:29 +00:00
84c13dab01
Adds the always-enabled _goal plugin with per-chat goal storage, WebUI goal strip, /goal slash command, and agent-facing goal tools. Includes command-picker integration, focused plugin tests, and the generated 256x256 thumbnail asset.
41 lines
2.3 KiB
Markdown
41 lines
2.3 KiB
Markdown
# Goal Plugin DOX
|
|
|
|
## Purpose
|
|
|
|
- Own the built-in chat goal strip, `/goal` slash command, goal state API, and agent-facing goal tools.
|
|
- Keep chat goals scoped to the active chat context and stored as user data outside tracked plugin code.
|
|
|
|
## Ownership
|
|
|
|
- `plugin.yaml` owns the always-enabled `_goal` plugin metadata.
|
|
- `helpers/goals.py` owns file-backed goal storage under `usr/plugins/_goal/goals/` and goal status normalization.
|
|
- `api/goal.py` owns the WebUI JSON API for reading, editing, pausing, resuming, and deleting goals.
|
|
- `commands/` owns the `/goal` slash command contributed to `_commands`.
|
|
- `webui/` and `extensions/webui/` own the composer goal strip and inline controls.
|
|
- `tools/` and `prompts/` own agent-facing goal inspection, creation, and status update behavior.
|
|
- `extensions/python/message_loop_prompts_after/` owns injecting the active goal into agent context.
|
|
|
|
## Local Contracts
|
|
|
|
- Goal status values are `active`, `paused`, `complete`, and `blocked`.
|
|
- Active goals are injected into agent extras; paused and blocked goals remain visible in the UI, while complete goals are hidden.
|
|
- Goal records track accumulated active time with `elapsed_seconds` and `active_since`; pausing freezes elapsed time until resume.
|
|
- User controls may pause, resume, edit, or delete a goal; destructive delete uses inline confirmation. Model tools may create goals and mark them complete or blocked.
|
|
- `/goal <objective>` creates the goal and sends the objective as the user message so the agent starts working immediately.
|
|
- `/goal auto` fills the composer with a prompt asking the agent to create and manage its own goal instead of silently sending a message.
|
|
- Goal UI feedback uses toast notifications and inline controls, not modal dialogs.
|
|
|
|
## Work Guidance
|
|
|
|
- Keep goal state in `usr/plugins/_goal/`; do not store runtime goal data in tracked files.
|
|
- Keep the goal strip mounted through WebUI extension points instead of modifying core composer templates.
|
|
- Keep `_commands` compatibility in mind: `/goal` is a plugin-contributed command and should remain read-only in the command manager.
|
|
|
|
## Verification
|
|
|
|
- Run `conda run -n a0 pytest plugins/_goal/tests` after changing `_goal` backend behavior.
|
|
- Run `_commands` discovery tests when changing the `/goal` command contribution contract.
|
|
|
|
## Child DOX Index
|
|
|
|
No child DOX files.
|