Agent Zero AI framework
Improve Context Doctor output handling
linklitie85842c5dc81
diff --git a/plugins/_context_doctor/AGENTS.md b/plugins/_context_doctor/AGENTS.mdindex e287e37fe..365965bf1 100644--- a/plugins/_context_doctor/AGENTS.md+++ b/plugins/_context_doctor/AGENTS.md@@ -2,24 +2,25 @@## Purpose-- Repair malformed Agent Zero tool-call JSON and persist compact repaired output.+- Repair malformed Agent Zero tool-call JSON and preserve raw output as compact thoughts JSON when repair cannot produce a tool call.## Ownership-- `helpers/context_doctor.py` validates and repairs tool-call JSON.+- `helpers/context_doctor.py` transforms output and refreshes log fields.- `extensions/python/message_loop_result/` normalizes completed model output before default processing.-- `webui/config.html` exposes XML-output suppression only.+- `webui/config.html` exposes XML suppression and log-detail settings.## Local Contracts-- Repaired tool-call JSON is always minified.-- Invalid non-tool output is unchanged; native processing retains ownership.-- Do not write settings that alter repair mode or log content.+- Repaired and fallback JSON is always minified.+- Nonempty non-tool output becomes `{"thoughts":[raw]}`; XML-like output becomes `{}` only when suppression is enabled.+- Log kvps and heading always reflect transformed output; `update_log` controls only View Details content.+- A repaired `response` tool call refreshes the response log item when streaming did not create it.## Work Guidance- Keep repair scoped to complete tool-call JSON.-- Use framework-installed `json_repair`; apply the plugin-local parser patch before repair. Do not vendor dependencies.+- Use framework-installed `json_repair`; apply plugin-local parser patch before repair. Do not vendor dependencies.## Verificationdiff --git a/plugins/_context_doctor/extensions/python/message_loop_result/_10_context_doctor.py b/plugins/_context_doctor/extensions/python/message_loop_result/_10_context_doctor.pyindex 902efcb01..e0505613d 100644--- a/plugins/_context_doctor/extensions/python/message_loop_result/_10_context_doctor.py+++ b/plugins/_context_doctor/extensions/python/message_loop_result/_10_context_doctor.py@@ -1,12 +1,13 @@-"""Repair and minify model tool-call JSON before default processing."""+"""Repair model output and refresh its log details before default processing."""from __future__ import annotations+import jsonfrom typing import Any, overridefrom helpers.extension import Extensionfrom helpers.plugins import get_plugin_config-from plugins._context_doctor.helpers.context_doctor import repair_and_minify, update_log_item+from plugins._context_doctor.helpers.context_doctor import transform_response, update_log_itemclass ContextDoctor(Extension):@@ -17,18 +18,45 @@ class ContextDoctor(Extension):llm_result = result_data.get("llm_result")response = getattr(llm_result, "response", None)- if not isinstance(response, str):+ if not isinstance(response, str) or not response:returnconfig = get_plugin_config("_context_doctor", agent=self.agent) or {}- repaired = repair_and_minify(+ transformed = transform_response(response, suppress_xml=config.get("suppress_xml", True))- if repaired is None:- return+ llm_result.response = transformed- llm_result.response = repairedparams = getattr(getattr(self.agent, "loop_data", None), "params_temporary", None)- log_item = params.get("log_item_generating") if isinstance(params, dict) else None- if log_item is not None and config.get("update_log", False):- update_log_item(self.agent, log_item, repaired)+ if not isinstance(params, dict) or transformed == "{}":+ return++ log_item = params.get("log_item_generating")+ if log_item is not None:+ update_log_item(+ self.agent,+ log_item,+ transformed,+ update_log=config.get("update_log", False),+ raw_response=response,+ )++ try:+ parsed = json.loads(transformed)+ tool_args = parsed.get("tool_args", {}) if isinstance(parsed, dict) else {}+ response_text = tool_args.get("text") if parsed.get("tool_name") == "response" else None+ except (AttributeError, TypeError, ValueError):+ response_text = None+ if not isinstance(response_text, str) or not response_text.strip():+ return++ response_item = params.get("log_item_response")+ if response_item is None and log_item is not None:+ response_item = self.agent.context.log.log(+ type="response",+ heading=f"icon://chat {self.agent.agent_name}: Responding",+ id=getattr(log_item, "id", ""),+ )+ params["log_item_response"] = response_item+ if response_item is not None:+ response_item.update(content=response_text)diff --git a/plugins/_context_doctor/helpers/context_doctor.py b/plugins/_context_doctor/helpers/context_doctor.pyindex cc09ccd0d..4f4f7b48e 100644--- a/plugins/_context_doctor/helpers/context_doctor.py+++ b/plugins/_context_doctor/helpers/context_doctor.py@@ -1,4 +1,4 @@-"""Repair complete Agent Zero tool-call JSON into compact JSON."""+"""Repair completed model output into compact JSON."""from __future__ import annotations@@ -22,38 +22,88 @@ def _is_tool_call(value: Any) -> bool:)-def repair_and_minify(response: str, *, suppress_xml: bool) -> str | None:- """Return compact tool-call JSON, XML fallback, or ``None`` for other output."""- if not response:- return None+_A0_SALVAGE_SCHEMA = {+ "type": "object",+ "properties": {+ "thoughts": {"type": "array", "items": {"type": "string"}},+ "headline": {"type": "string"},+ "tool_name": {"type": "string"},+ "tool_args": {"type": "object"},+ },+ "required": [],+}- try:- from plugins._context_doctor.helpers.json_repair_patch import apply_patch- from json_repair import repair_json- apply_patch()- repaired = repair_json(response, return_objects=True)- except Exception:- return "{}" if suppress_xml and "<" in response and ">" in response else None+def _a0_completeness_score(value: dict[str, Any]) -> int:+ return sum(field in value for field in ("thoughts", "headline", "tool_name", "tool_args")) + bool(+ value.get("tool_args")+ )+- if isinstance(repaired, list):- repaired = next((item for item in repaired if _is_tool_call(item)), None)- if _is_tool_call(repaired):- return json.dumps(repaired, ensure_ascii=False, separators=(",", ":"))- return "{}" if suppress_xml and "<" in response and ">" in response else None+def transform_response(response: str, *, suppress_xml: bool) -> str:+ """Return compact repaired tool JSON or a compact raw-text fallback."""+ if response:+ try:+ from plugins._context_doctor.helpers.json_repair_patch import apply_patch+ from json_repair import repair_json+ apply_patch()+ try:+ repaired = repair_json(+ response,+ return_objects=True,+ schema=_A0_SALVAGE_SCHEMA,+ schema_repair_mode="salvage",+ )+ except Exception:+ repaired = repair_json(response, return_objects=True)++ candidates = repaired if isinstance(repaired, list) else [repaired]+ try:+ no_schema = repair_json(response, return_objects=True)+ except Exception:+ no_schema = None+ if isinstance(no_schema, list):+ valid = [item for item in no_schema if _is_tool_call(item)]+ if len(valid) > 1 or (len(valid) == 1 and not _is_tool_call(repaired)):+ candidates = no_schema+ repaired = max(+ (item for item in candidates if _is_tool_call(item)),+ key=_a0_completeness_score,+ default=None,+ )+ except Exception:+ repaired = None-def update_log_item(agent: Any, log_item: Any, response: str) -> None:- """Replace final log details with repaired JSON and derived display fields."""+ if _is_tool_call(repaired):+ return json.dumps(repaired, ensure_ascii=False, separators=(",", ":"))++ if suppress_xml and "<" in response and ">" in response:+ return "{}"+ return json.dumps({"thoughts": [response]}, ensure_ascii=False, separators=(",", ":"))+++def update_log_item(+ agent: Any,+ log_item: Any,+ response: str,+ *,+ update_log: bool,+ raw_response: str,+) -> None:+ """Refresh log fields from transformed JSON; optionally replace raw details."""try:parsed = json.loads(response)- if not _is_tool_call(parsed):+ if not isinstance(parsed, dict):return- heading = parsed.get("headline") or f"Using {parsed['tool_name']}"- log_item.update(- content=response,- kvps=parsed,- heading=f"{getattr(agent, 'agent_name', 'A0')}: {heading}",- )+ heading = parsed.get("headline")+ if not isinstance(heading, str) or not heading:+ tool_name = parsed.get("tool_name")+ heading = f"Using {tool_name}" if isinstance(tool_name, str) else ""+ kwargs: dict[str, Any] = {"kvps": parsed}+ if heading:+ kwargs["heading"] = f"{getattr(agent, 'agent_name', 'A0')}: {heading}"+ kwargs["content"] = response if update_log else raw_response+ log_item.update(**kwargs)except (AttributeError, TypeError, ValueError):passdiff --git a/plugins/_context_doctor/tests/test_context_doctor.py b/plugins/_context_doctor/tests/test_context_doctor.pyindex bddee63f9..8ac47e1af 100644--- a/plugins/_context_doctor/tests/test_context_doctor.py+++ b/plugins/_context_doctor/tests/test_context_doctor.py@@ -1,78 +1,123 @@from types import SimpleNamespace-from plugins._context_doctor.helpers.context_doctor import repair_and_minify, update_log_itemfrom plugins._context_doctor.extensions.python.message_loop_result._10_context_doctor import (ContextDoctor,)+from plugins._context_doctor.helpers.context_doctor import transform_response, update_log_itemdef test_repairs_and_minifies_tool_call():response = '{"tool_name":"response","tool_args":{"text":"ok",},}'- assert repair_and_minify(response, suppress_xml=True) == (+ assert transform_response(response, suppress_xml=True) == ('{"tool_name":"response","tool_args":{"text":"ok"}}')-def test_ignores_non_tool_json():- assert repair_and_minify('{"message":"ok"}', suppress_xml=True) is None-+def test_chooses_most_complete_tool_call():+ response = (+ '{"tool_name":"first","tool_args":{}} '+ '{"thoughts":["x"],"headline":"Second","tool_name":"second","tool_args":{"x":1}}'+ )-def test_suppresses_xml_when_enabled():- assert repair_and_minify('<tool>response</tool>', suppress_xml=True) == "{}"- assert repair_and_minify('<tool>response</tool>', suppress_xml=False) is None+ assert transform_response(response, suppress_xml=True) == (+ '{"thoughts":["x"],"headline":"Second","tool_name":"second","tool_args":{"x":1}}'+ )-def test_extension_replaces_completed_result(monkeypatch):- monkeypatch.setattr(- "plugins._context_doctor.extensions.python.message_loop_result._10_context_doctor.get_plugin_config",- lambda *args, **kwargs: {"suppress_xml": True},+def test_wraps_raw_text_in_thoughts():+ assert transform_response("plain text", suppress_xml=True) == (+ '{"thoughts":["plain text"]}')- llm_result = SimpleNamespace(- response='{"tool_name":"response","tool_args":{"text":"ok",},}'- )- agent = SimpleNamespace(loop_data=SimpleNamespace(params_temporary={}))- ContextDoctor(agent).execute({"llm_result": llm_result})- assert llm_result.response == '{"tool_name":"response","tool_args":{"text":"ok"}}'+def test_suppresses_xml_when_enabled():+ assert transform_response("<tool>response</tool>", suppress_xml=True) == "{}"+ assert transform_response("<tool>response</tool>", suppress_xml=False) == (+ '{"thoughts":["<tool>response</tool>"]}'+ )-def test_updates_log_with_repaired_tool_call():+def test_updates_log_kvps_and_heading_while_preserving_raw_content():log_item = SimpleNamespace(update=lambda **kwargs: setattr(log_item, "data", kwargs))+ raw = '{"tool_name":"response","tool_args":{"text":"ok",},}'+ repaired = '{"headline":"Done","tool_name":"response","tool_args":{"text":"ok"}}'update_log_item(SimpleNamespace(agent_name="A0"),log_item,- '{"headline":"Done","tool_name":"response","tool_args":{"text":"ok"}}',+ repaired,+ update_log=False,+ raw_response=raw,)- assert log_item.data["content"] == (- '{"headline":"Done","tool_name":"response","tool_args":{"text":"ok"}}'- )+ assert log_item.data["content"] == raw+ assert log_item.data["kvps"]["tool_name"] == "response"assert log_item.data["heading"] == "A0: Done"-def test_extension_updates_log_only_when_enabled(monkeypatch):+def test_extension_replaces_result_refreshes_log_and_response_item(monkeypatch):+ monkeypatch.setattr(+ "plugins._context_doctor.extensions.python.message_loop_result._10_context_doctor.get_plugin_config",+ lambda *args, **kwargs: {"suppress_xml": True, "update_log": False},+ )llm_result = SimpleNamespace(response='{"tool_name":"response","tool_args":{"text":"ok",},}')- log_item = SimpleNamespace(update=lambda **kwargs: setattr(log_item, "data", kwargs))+ log_item = SimpleNamespace(+ id="generating", update=lambda **kwargs: setattr(log_item, "data", kwargs)+ )+ response_item = SimpleNamespace(update=lambda **kwargs: setattr(response_item, "data", kwargs))+ context = SimpleNamespace(log=SimpleNamespace(log=lambda **kwargs: response_item))agent = SimpleNamespace(agent_name="A0",+ context=context,loop_data=SimpleNamespace(params_temporary={"log_item_generating": log_item}),)+ ContextDoctor(agent).execute({"llm_result": llm_result})++ assert llm_result.response == '{"tool_name":"response","tool_args":{"text":"ok"}}'+ assert log_item.data["content"] != llm_result.response+ assert log_item.data["kvps"]["tool_name"] == "response"+ assert response_item.data == {"content": "ok"}+++def test_extension_does_not_create_response_item_for_other_tools(monkeypatch):monkeypatch.setattr("plugins._context_doctor.extensions.python.message_loop_result._10_context_doctor.get_plugin_config",lambda *args, **kwargs: {"suppress_xml": True, "update_log": False},)+ log_item = SimpleNamespace(id="generating", update=lambda **kwargs: None)+ agent = SimpleNamespace(+ agent_name="A0",+ context=SimpleNamespace(log=SimpleNamespace(log=lambda **kwargs: None)),+ loop_data=SimpleNamespace(params_temporary={"log_item_generating": log_item}),+ )+ llm_result = SimpleNamespace(+ response='{"tool_name":"notify_user","tool_args":{"message":"not final"}}'+ )+ContextDoctor(agent).execute({"llm_result": llm_result})- assert not hasattr(log_item, "data")+ assert "log_item_response" not in agent.loop_data.params_temporary+++def test_extension_does_not_use_legacy_response_message_key(monkeypatch):monkeypatch.setattr("plugins._context_doctor.extensions.python.message_loop_result._10_context_doctor.get_plugin_config",- lambda *args, **kwargs: {"suppress_xml": True, "update_log": True},+ lambda *args, **kwargs: {"suppress_xml": True, "update_log": False},+ )+ log_item = SimpleNamespace(id="generating", update=lambda **kwargs: None)+ agent = SimpleNamespace(+ agent_name="A0",+ context=SimpleNamespace(log=SimpleNamespace(log=lambda **kwargs: None)),+ loop_data=SimpleNamespace(params_temporary={"log_item_generating": log_item}),+ )+ llm_result = SimpleNamespace(+ response='{"tool_name":"response","tool_args":{"message":"not final"}}')+ContextDoctor(agent).execute({"llm_result": llm_result})- assert log_item.data["content"] == llm_result.response++ assert "log_item_response" not in agent.loop_data.params_temporary