| 1 | # a2a_chat.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `a2a_chat.py` agent tool. |
| 6 | - This module lets the agent message an external A2A agent and extract the assistant reply. |
| 7 | - Keep this file-level DOX profile synchronized with `a2a_chat.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `a2a_chat.py` owns the runtime implementation. |
| 12 | - `a2a_chat.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Classes: |
| 14 | - `A2AChatTool` (`Tool`) |
| 15 | - `async execute(self, **kwargs)` |
| 16 | - Top-level functions: |
| 17 | - `_session_key(agent_url: str) -> str`: Keep root and explicit /a2a URLs in the same conversation cache. |
| 18 | - `_text_from_part(part: Any) -> str` |
| 19 | - `_text_from_message(message: Any) -> str` |
| 20 | - `_extract_latest_assistant_text(task_response: Any) -> str` |
| 21 | - Notable constants/configuration names: `A2A_EMPTY_RESPONSE_ERROR`. |
| 22 | |
| 23 | ## Runtime Contracts |
| 24 | |
| 25 | - Tool modules must define `helpers.tool.Tool` subclasses and return `helpers.tool.Response` from `execute(...)`. |
| 26 | - Update this file whenever tool arguments, output shape, `break_loop` behavior, intervention handling, prompt instructions, or side effects change. |
| 27 | - `A2AChatTool` is a `Tool`. |
| 28 | - `A2AChatTool` defines `execute(...)`. |
| 29 | - Observed side-effect areas: filesystem writes, scheduler state. |
| 30 | - Imported dependency areas include: `helpers.fasta2a_client`, `helpers.print_style`, `helpers.tool`, `typing`. |
| 31 | |
| 32 | ## Key Concepts |
| 33 | |
| 34 | - Important called helpers/classes observed in the source: `agent_url.rstrip`, `normalized.endswith`, `_text_from_message`, `normalized.rstrip`, `message.strip`, `join`, `_session_key`, `value.strip`, `_text_from_part`, `is_client_available`, `Response`, `self.agent.get_data`, `sessions.pop`, `_extract_latest_assistant_text`, `PrintStyle.error`, `connect_to_agent`, `conn.send_message`, `conn.wait_for_completion`, `self.agent.set_data`. |
| 35 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 36 | |
| 37 | ## Work Guidance |
| 38 | |
| 39 | - Keep tool output concise, model-readable, and safe for history persistence. |
| 40 | - Coordinate argument or behavior changes with prompt tool instructions and skill guidance. |
| 41 | - Respect intervention flow for long-running, external, or user-visible operations. |
| 42 | |
| 43 | ## Verification |
| 44 | |
| 45 | - Run targeted tool and prompt-contract tests for changed behavior; smoke-test agent execution when no focused test exists. |
| 46 | - Related tests observed by source search: |
| 47 | - `tests/test_tool_action_contracts.py` |
| 48 | |
| 49 | ## Child DOX Index |
| 50 | |
| 51 | No child DOX files. |