| 1 | # Prompts DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own core prompt templates used by agents, tools, framework messages, behavior updates, summaries, skills, projects, and system context. |
| 6 | - Keep prompt contracts explicit and synchronized with code that renders them. |
| 7 | |
| 8 | ## Ownership |
| 9 | |
| 10 | - `agent.*.md` and companion `.py` files provide system, context, tool, project, skill, and behavior prompt material. |
| 11 | - `fw.*.md` files provide framework-generated message templates. |
| 12 | - Profile-specific prompt overrides belong under `agents/<profile>/prompts/`. |
| 13 | - Plugin prompt additions belong under the relevant plugin `prompts/` directory. |
| 14 | |
| 15 | ## Local Contracts |
| 16 | |
| 17 | - Do not include secrets, real API keys, or private user data in prompt templates. |
| 18 | - Keep placeholder names, include aliases, and template assumptions synchronized with prompt-loading code and extensions. |
| 19 | - Prompt changes can alter agent behavior; keep edits narrow and intentional. |
| 20 | - Maintain clear separation between core behavior prompts and profile/plugin-specific customization. |
| 21 | - Summary prompts that compress history should preserve loaded skill names from `skill_instructions` metadata without copying full skill bodies. |
| 22 | |
| 23 | ## Work Guidance |
| 24 | |
| 25 | - Read the rendering path before changing placeholders or filenames. |
| 26 | - Prefer small prompt additions over broad rewrites when fixing a specific behavior. |
| 27 | - Keep document/OCR routing explicit: image files, screenshots, scans, charts, photos, and diagrams should prefer vision tools when available, while `document_query` is for documents, large text-heavy files, and fallback OCR. |
| 28 | - Keep the single `vision_load` tool prompt route-agnostic and preserve one-call loading for related images; internal image-analysis instructions belong in framework prompts, not Python strings. |
| 29 | - Update tests or snapshots when prompt budget, required sections, or generated system content changes. |
| 30 | |
| 31 | ## Verification |
| 32 | |
| 33 | - Run targeted prompt, budget, snapshot, tool, or behavior tests after prompt changes. |
| 34 | - Inspect rendered prompt output when changing template wiring or placeholders. |
| 35 | |
| 36 | ## Child DOX Index |
| 37 | |
| 38 | No child DOX files. |