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/_text_editor
History
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
..
extensions refactor: split system prompt into per-concern extensions with extensibility hooks 2026-03-20 12:12:47 +08:00
helpers fix: tighten tool guidance and editor workflows 2026-05-11 11:51:58 +02:00
prompts Split text editor and Office artifact ownership 2026-05-22 11:21:04 +02:00
tools Split text editor and Office artifact ownership 2026-05-22 11:21:04 +02:00
webui generated logos for builtin plugins 2026-03-19 17:35:03 +01:00
AGENTS.md Add file-level DOX docs & update AGENTS indexes 2026-06-08 12:41:53 +02:00
default_config.yaml refactor - plugin names and builtin plugins 2026-03-10 22:20:53 +01:00
plugin.yaml refactor - plugin names and builtin plugins 2026-03-10 22:20:53 +01:00
README.md refactor: normalize plugin paths, add README viewer to plugin info modal, and update plugin hub filters 2026-03-22 08:05:32 +01:00

README.md

Text Editor

Provide an LLM-friendly file editing tool for reading, writing, and patching text files.

What It Does

This plugin exposes a native text editing tool that agents can use to inspect files, write complete contents, and apply validated patch operations while tracking file freshness between reads and edits.

Main Behavior

  • Read
    • Reads whole files or line ranges with token-aware limits.
    • Records file metadata so later patch operations can detect stale edits.
  • Write
    • Writes full file contents and then re-reads the resulting file for confirmation.
  • Patch
    • Validates edit structures before applying them.
    • Rejects edits if the file changed since it was last observed.
    • Reads back the affected patch region after applying changes.
  • Extension hooks
    • Exposes before and after extension points for read, write, and patch operations.

Key Files

  • Tool
    • tools/text_editor.py implements method dispatch, stale-file checks, patching flow, and prompt responses.
  • Helpers
    • helpers/file_ops.py provides file info, read/write helpers, edit validation, and patch application.
  • Configuration
    • default_config.yaml defines read limits and token budgets.
  • Prompts
    • prompts/ contains the agent-facing success and error messages.

Configuration Scope

  • Settings section: agent
  • Per-project config: true
  • Per-agent config: true

Plugin Metadata

  • Name: _text_editor
  • Title: Text Editor
  • Description: Native tool to read, write, and patch text files in an LLM-friendly way.