| 1 | # document_query.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `document_query.py` agent tool. |
| 6 | - This module loads and queries documents through the document query plugin compatibility path. |
| 7 | - Keep this file-level DOX profile synchronized with `document_query.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `document_query.py` owns the runtime implementation. |
| 12 | - `document_query.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | |
| 14 | ## Runtime Contracts |
| 15 | |
| 16 | - Tool modules must define `helpers.tool.Tool` subclasses and return `helpers.tool.Response` from `execute(...)`. |
| 17 | - Update this file whenever tool arguments, output shape, `break_loop` behavior, intervention handling, prompt instructions, or side effects change. |
| 18 | - Observed side-effect areas: plugin state. |
| 19 | - Imported dependency areas include: `plugins._document_query.tools.document_query`. |
| 20 | |
| 21 | ## Key Concepts |
| 22 | |
| 23 | - This module is primarily declarative or delegates behavior through classes/imported objects. |
| 24 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 25 | |
| 26 | ## Work Guidance |
| 27 | |
| 28 | - Keep tool output concise, model-readable, and safe for history persistence. |
| 29 | - Coordinate argument or behavior changes with prompt tool instructions and skill guidance. |
| 30 | - Respect intervention flow for long-running, external, or user-visible operations. |
| 31 | |
| 32 | ## Verification |
| 33 | |
| 34 | - Run targeted tool and prompt-contract tests for changed behavior; smoke-test agent execution when no focused test exists. |
| 35 | - Related tests observed by source search: |
| 36 | - `tests/test_document_query_fallback.py` |
| 37 | - `tests/test_document_query_plugin.py` |
| 38 | |
| 39 | ## Child DOX Index |
| 40 | |
| 41 | No child DOX files. |