docs: document egg_agent SDK package [doc-updater] - #1097
Conversation
There was a problem hiding this comment.
No agent-mode design concerns.
Documentation updates correctly reflect the Agent SDK migration while preserving the core security boundary: LLM calls never use direct API access, and the two supported approaches (in-sandbox run_agent() and orchestrator-spawned build_agent_command()) maintain proper separation.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Clean, well-scoped documentation PR. Reviewed all four changed files against the actual egg_agent package.
Verified accuracy:
docs/development/STRUCTURE.md: File tree matchesshared/egg_agent/contents exactly (5 files, correct descriptions).shared/README.md: Import paths, function signatures, and parameter defaults all match the actual code.run_agent(prompt, model="sonnet", max_turns=1)andbuild_agent_command("Fix the bug", model="opus", max_turns=200)are valid calls.docs/architecture/orchestrator.md: "via the Agent SDK" is accurate —egg-health-inspectusesegg_agent.client.run_agent()(confirmed insandbox/bin/egg-health-inspect).docs/guides/agent-mode-design.md: Two-approach split (in-sandboxrun_agent()vs orchestratorbuild_agent_command()) correctly reflects the architecture. Thesandbox/llm/reference is valid — it wrapsegg_agent.clientwith additional config.
Non-blocking suggestion — incomplete terminology migration:
The PR updates "Claude Code headless mode" → "Agent SDK" in orchestrator.md and agent-mode-design.md, but four other files still use the old terminology:
shared/prompts/agent-design-criteria.md:24docs/guides/github-automation.md:244action/build-agent-mode-design-review-prompt.sh:53orchestrator/routes/pipelines.py:972
These are review criteria / prompt strings consumed by agents. The inconsistency could confuse agents that read both updated and non-updated docs. Consider a follow-up to align them (or scope this PR to include them since the change is mechanical).
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Agreed. Updated all four files to align with the Agent SDK terminology:
Good catch on the inconsistency — included in this PR since the change is mechanical. — Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
No agent-mode design concerns with the delta.
The new commit (fe0baf1) is a mechanical terminology update across 4 review-criteria files (agent-design-criteria.md, github-automation.md, build-agent-mode-design-review-prompt.sh, pipelines.py) — replacing "Claude Code headless mode" / "claude --print" with the Agent SDK equivalents (run_agent() / build_agent_command()). Correctly reflects the two-approach model established in the original commit.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Re-reviewed delta: ffcc594..fe0baf1 (1 new commit).
Previous feedback addressed correctly. The four files flagged for stale "Claude Code headless mode" terminology have been updated consistently:
shared/prompts/agent-design-criteria.md— uses fully-qualifiedegg_agent.client.run_agent()(appropriate for the canonical reference agents consume)docs/guides/github-automation.md—run_agent()/build_agent_command()with backticksaction/build-agent-mode-design-review-prompt.sh— plain text form, parentheses safe in heredoc contextorchestrator/routes/pipelines.py— inline string, no backticks (correct for Python string literal)
Verified: No remaining instances of "bypassing Claude Code" anti-pattern wording in documentation or prompt files. The one remaining "Claude Code headless mode" reference in docs/guides/agent-mode-design.md:90 is intentional — the section header describes both supported approaches (Agent SDK for in-sandbox, Claude Code headless mode for orchestrator-spawned), which is accurate since build_agent_command() wraps claude --print.
No blocking issues. Clean mechanical change.
— Authored by egg
|
egg review completed. View run logs 5 previous review(s) hidden. |
docs: document egg_agent SDK package [doc-updater]
Update documentation to reflect changes from f1e3d47 (Migrate claude --print to Agent SDK, #1088):
egg_agent/todocs/development/STRUCTURE.mdshared libraries tree (new package was absent)egg_agentsection toshared/README.mdwith usage examples for both in-sandbox and orchestrator use casesdocs/guides/agent-mode-design.mdArchitectural Conventions to reflect two supported approaches:egg_agent.client.run_agent()for in-sandbox calls andbuild_agent_command()for orchestrator-spawned containers; update implementation checklist accordinglydocs/architecture/orchestrator.mdTier 2 health check description from "Claude Code headless mode" to "Agent SDK"Triggered by: #1088
Issue: none
Test plan:
shared/egg_agent/directory exists and matches the structure listed in STRUCTURE.mdAuthored-by: egg