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/_document_query/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

1 KiB
Raw Blame History

Document Query Plugin DOX

Purpose

  • Own document loading, parsing, indexing, and Q&A over local and remote documents.

Ownership

  • tools/document_query.py owns the agent-facing query tool.
  • helpers/ owns fetching, parser routing, indexing, and query orchestration.
  • prompts/ owns document-query tool and optimization prompts.
  • hooks.py, default_config.yaml, plugin.yaml, skills/, extensions/, and webui/ own dependency bootstrap, settings, metadata, skill guidance, hooks, and UI.

Local Contracts

  • Respect configured size, timeout, retry, parser concurrency, and OCR limits.
  • Fetch local and remote resources safely and avoid leaking document contents beyond intended prompt/tool use.
  • Keep optional dependency installation targeted to the framework runtime.

Work Guidance

  • Coordinate parser changes with timeout handling and fallback behavior.

Verification

  • Smoke-test representative PDF, text/HTML, image/OCR, and remote-document queries after parser changes.

Child DOX Index

No child DOX files.