agent-zero/plugins/_promptinclude/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

989 B

Prompt Include Plugin DOX

Purpose

  • Own automatic prompt injection of persistent behavioral rules and preferences from *.promptinclude.md files.

Ownership

  • helpers/scanner.py owns workspace scanning, ignore handling, token budgeting, and trimming.
  • prompts/ owns prompt-inclusion fragments.
  • extensions/ owns prompt injection hooks.
  • default_config.yaml, plugin.yaml, README.md, and webui/ own defaults, metadata, behavior notes, and settings UI.

Local Contracts

  • Respect gitignore-style filtering, per-file budgets, and total token budgets.
  • Include only intended promptinclude files from configured workspaces.
  • Keep scan result status fields accurate for skipped, cropped, and included files.

Work Guidance

  • Coordinate scanner changes with prompt fragments so included content is clearly attributed.

Verification

  • Smoke-test include, ignore, crop, and over-budget cases after scanner changes.

Child DOX Index

No child DOX files.