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

Text Editor Plugin DOX

Purpose

  • Own the native LLM-friendly text editing tool for reading, writing, and patching text files.

Ownership

  • tools/text_editor.py owns method dispatch and agent-facing tool behavior.
  • helpers/ owns file operations, patch requests, context patching, stale-read tracking, and patch state.
  • prompts/ owns read/write/patch success and error messages.
  • default_config.yaml, plugin.yaml, README.md, extensions/, and webui/ own defaults, metadata, docs, hooks, and config UI.

Local Contracts

  • Preserve stale-read protection before patch operations.
  • Validate patch structures before applying edits.
  • Read back changed regions after writes or patches where the tool contract requires confirmation.

Work Guidance

  • Coordinate helper changes with prompt responses so the agent receives actionable edit feedback.

Verification

  • Smoke-test read, write, patch, stale-read rejection, and error handling after tool changes.

Child DOX Index

No child DOX files.