From bcdc99e6cce68bb5f951bea89993997736f85536 Mon Sep 17 00:00:00 2001 From: Alessandro <155005371+3clyp50@users.noreply.github.com> Date: Thu, 2 Jul 2026 16:36:01 +0200 Subject: [PATCH] Clarify optional memory plugin docs Remove memory-plugin assumptions from root and non-plugin DOX contracts so disabled plugins are not implied as available runtime behavior. Keep the memory plugin documented only in its owning plugin subtree and mark it optional from the parent plugin index. --- AGENTS.md | 8 ++++---- agents/researcher/AGENTS.md | 2 +- agents/tiny-local/AGENTS.md | 2 +- extensions/python/hist_add_before/AGENTS.md | 2 +- knowledge/AGENTS.md | 2 +- plugins/AGENTS.md | 2 +- tests/AGENTS.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 549f6b559..31ab6a620 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -88,9 +88,9 @@ When running in Docker, Agent Zero uses two distinct Python runtimes to isolate ├── agents/ # Agent profiles (prompts and config) ├── prompts/ # System and message prompt templates ├── knowledge/ -│ └── main/about/ # Agent self-knowledge (indexed into vector DB for runtime recall) +│ └── main/about/ # Agent self-knowledge reference material │ ├── identity.md # Philosophy, principles, project context -│ ├── architecture.md # Agent loop, memory pipeline, multi-agent, extensions +│ ├── architecture.md # Agent loop, multi-agent coordination, extensions │ ├── capabilities.md # Detailed capabilities and limitations │ ├── configuration.md # LLM roles, providers, profiles, plugins, settings │ └── setup-and-deployment.md # Docker deployment, updates, troubleshooting @@ -104,7 +104,7 @@ Key Files: - helpers/api.py: Base class for all API endpoints. - models.py: LLM provider configuration and LiteLLM wrappers; framework LiteLLM defaults such as `drop_params=True` are merged with `litellm_global_kwargs`, configured values override framework defaults, documented module-level switches such as `drop_params` are applied to LiteLLM, and merged kwargs are passed per call. - scripts/openrouter_release_notes_system_prompt.md: Editable system prompt used to generate GitHub release notes during Docker publishing. -- knowledge/main/about/: Agent self-knowledge files, indexed into the vector DB for runtime recall. Not user-facing docs - written for the agent's internal reference. +- knowledge/main/about/: Agent self-knowledge files. Not user-facing docs - written for the agent's internal reference. - webui/components/AGENTS.md: DOX contract for Alpine component architecture. - webui/js/AGENTS.md: DOX contract for frontend infrastructure, modal stack, API helpers, and extension loading. - plugins/AGENTS.md: DOX contract for bundled and custom plugin architecture; `usr/plugins/` remains ignored user state. @@ -274,7 +274,7 @@ pip install -r requirements.txt 6. Use the nearest AGENTS.md as the local contract and parent docs for repo-wide rules 7. If docs conflict, the closer doc controls local work details, but no child doc may weaken DOX -Do not rely on memory. Re-read the applicable DOX chain in the current session before editing. +Do not rely on prior context. Re-read the applicable DOX chain in the current session before editing. ## Update After Editing diff --git a/agents/researcher/AGENTS.md b/agents/researcher/AGENTS.md index e6ba59c70..dd7e41def 100644 --- a/agents/researcher/AGENTS.md +++ b/agents/researcher/AGENTS.md @@ -19,7 +19,7 @@ ## Work Guidance - Prefer prompt changes that improve citation, evidence handling, and analysis quality for research tasks. -- Coordinate broad research behavior changes with document, memory, or browser plugin contracts when relevant. +- Coordinate broad research behavior changes with document or browser plugin contracts when relevant. ## Verification diff --git a/agents/tiny-local/AGENTS.md b/agents/tiny-local/AGENTS.md index e176f2422..86715f4dc 100644 --- a/agents/tiny-local/AGENTS.md +++ b/agents/tiny-local/AGENTS.md @@ -17,7 +17,7 @@ ## Local Contracts - Preserve the normal Agent Zero tool-call shape: `tool_name` plus `tool_args`. -- Do not add parser repair, duplicate suppression runtime, model transport, memory, or text-editor runtime behavior here. +- Do not add parser repair, duplicate suppression runtime, model transport, or text-editor runtime behavior here. - Duplicate-message handling may be tightened through profile prompts only. - Keep prompt text short enough for small local models to follow. - Treat continuation requests such as `proceed` or `continue` as commands to execute the next unfinished step, not as prompts for another status response. diff --git a/extensions/python/hist_add_before/AGENTS.md b/extensions/python/hist_add_before/AGENTS.md index 7553e0618..791b47294 100644 --- a/extensions/python/hist_add_before/AGENTS.md +++ b/extensions/python/hist_add_before/AGENTS.md @@ -15,7 +15,7 @@ ## Work Guidance -- Coordinate history mutation changes with message persistence and memory behavior. +- Coordinate history mutation changes with message persistence and plugin-owned history consumers. ## Verification diff --git a/knowledge/AGENTS.md b/knowledge/AGENTS.md index 8075b4686..4ee093f65 100644 --- a/knowledge/AGENTS.md +++ b/knowledge/AGENTS.md @@ -13,7 +13,7 @@ ## Local Contracts -- Do not place secrets, chat transcripts, private user memory, or local deployment details in repository knowledge. +- Do not place secrets, chat transcripts, private user data, or local deployment details in repository knowledge. - Keep self-knowledge consistent with current architecture, configuration, capabilities, and setup docs. - Markdown here is for agent runtime context, not general marketing copy. diff --git a/plugins/AGENTS.md b/plugins/AGENTS.md index 4a3ca693b..740879f67 100644 --- a/plugins/AGENTS.md +++ b/plugins/AGENTS.md @@ -79,7 +79,7 @@ Direct child DOX files: | [_error_retry/AGENTS.md](_error_retry/AGENTS.md) | Critical exception retry lifecycle hooks. | | [_infection_check/AGENTS.md](_infection_check/AGENTS.md) | Prompt-injection safety analysis before tool execution. | | [_kokoro_tts/AGENTS.md](_kokoro_tts/AGENTS.md) | Kokoro text-to-speech integration. | -| [_memory/AGENTS.md](_memory/AGENTS.md) | Persistent vector memory, knowledge import, tools, and dashboard. | +| [_memory/AGENTS.md](_memory/AGENTS.md) | Optional persistent recall plugin, knowledge import, tools, and dashboard; do not assume it is enabled outside this plugin. | | [_model_config/AGENTS.md](_model_config/AGENTS.md) | Model selection, presets, API-key checks, and scoped overrides. | | [_oauth/AGENTS.md](_oauth/AGENTS.md) | OAuth-backed model-provider connections and local proxy routes. | | [_office/AGENTS.md](_office/AGENTS.md) | LibreOffice office artifacts and office canvas sessions. | diff --git a/tests/AGENTS.md b/tests/AGENTS.md index a2a74f5a3..e10e015cd 100644 --- a/tests/AGENTS.md +++ b/tests/AGENTS.md @@ -14,7 +14,7 @@ ## Local Contracts - Tests must not require real API keys, network-only services, private user data, or local `usr/` runtime state. -- Keep tests deterministic and isolated from existing chats, uploads, downloads, memory, and settings. +- Keep tests deterministic and isolated from existing chats, uploads, downloads, plugin state, and settings. - Prefer exercising public helper/API contracts over fragile implementation details when practical. - Security regression tests should assert the protected behavior directly.