Skip to content

docs: Update agent-mode-design for Agent SDK migration [doc-updater] - #1191

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-agent-sdk-migration
Mar 16, 2026
Merged

docs: Update agent-mode-design for Agent SDK migration [doc-updater]#1191
jwbron merged 1 commit into
mainfrom
egg/doc-update-agent-sdk-migration

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

docs: Update agent-mode-design for Agent SDK migration

Update code example in agent-mode-design.md that was rendered stale by
commit 487fea5 ("Migrate orchestrator from claude --print to Agent SDK").

The "Anti-pattern 3" section's "Right approach" example previously showed
["claude", "--print", "--max-turns", "1", ...] as the correct way to
delegate LLM calls from the orchestrator to sandbox containers. With the
migration, the orchestrator now uses build_agent_command() which returns
python3 -m egg_agent — not the claude CLI. The example now correctly
reflects this pattern.

Issue: none

Test plan:

  • Verify the updated code example matches shared/egg_agent/command.py
    build_agent_command() signature and usage.

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No agent-mode design concerns.

This is a documentation-only change that updates the "Anti-pattern 3" code example to reflect the build_agent_command() migration. The updated example correctly shows the current pattern.

— Authored by egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation change accurately reflects the codebase. Verified:

  • Import path from egg_agent import build_agent_command matches shared/egg_agent/__init__.py export and existing usage in orchestrator/routes/pipelines.py.
  • build_agent_command(prompt=..., max_turns=1) matches the real signature in shared/egg_agent/command.py.
  • Return type list[str] is compatible with the command= parameter on spawn_agent_container().

No issues.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit 51c7441 into main Mar 16, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant