vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-10 01:18:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/plugins/_orchestrator/api/AGENTS.md
Alessandro f64b6490c5 Add bundled Orchestrator plugin 
Promote the terminal agent work into the built-in plugins tree as _orchestrator with Orchestrator branding and the orchestrator skill.

Include adapter status APIs, settings UI, per-agent skill references, thumbnail asset, tests, and DOX coverage for the bundled plugin.
2026-07-09 13:18:44 +02:00

1.9 KiB
Raw Permalink Blame History

Orchestrator API - AGENTS.md

Purpose

  • Expose small plugin HTTP handlers used by the Orchestrator settings screen.
  • Report registered adapter status and manage only supported, safe auth operations.

Ownership

  • Owns status.py, start_device_login.py, poll_device_login.py, disconnect.py, and package initialization for plugin APIs.
  • Does not own execution of terminal agents, installation of CLIs, or generic credential collection.

Local Contracts

  • API handlers derive from helpers.api.ApiHandler.
  • Read plugin settings through helpers.plugins.get_plugin_config("_orchestrator").
  • Use plugins._orchestrator.helpers.registry for adapter lookup and per-adapter config extraction.
  • Return JSON dictionaries with ok and enough context for the WebUI to show a useful error. Do not let adapter exceptions escape to the user as framework failures.
  • status may include install_hint for display/help only; it must not trigger installation.
  • Device-login endpoints must reject adapters that do not explicitly support device login.
  • disconnect may remove only known credential stores or invoke a known safe CLI logout. It must not delete broad home directories or provider config trees.

Work Guidance

  • Keep response shapes stable for webui/orchestrator-store.js.
  • When adding adapter auth behavior, update status.py only if the shared response needs a new field.
  • Never return token values, API keys, refresh tokens, or raw credential JSON.

Verification

  • Run the plugin self-check after API changes: 
    docker exec 8dc967046cda bash -lc 'cd /a0 && /opt/venv-a0/bin/python plugins/_orchestrator/tests/test_status_adapters.py'
  • For import-only API changes, use the Agent Zero framework runtime: 
    docker exec 8dc967046cda bash -lc 'cd /a0 && /opt/venv-a0/bin/python -m py_compile plugins/_orchestrator/api/*.py'

Child DOX Index

This folder has no child DOX files.