Skip to content

docs(sdk): document max_steps framework default of 50 - #5759

Merged
kovtcharov-amd merged 1 commit into
amd:mainfrom
amandeavor:fix/3533-sdk-max-steps-docs
Oct 26, 2026
Merged

kovtcharov-amd merged 1 commit into
amd:mainfrom
amandeavor:fix/3533-sdk-max-steps-docs

Conversation

@amandeavor

Copy link
Copy Markdown
Contributor

Why

Closes #3533

The SDK guide documented max_steps default as 20 in three places, and ChatAgentConfig documented 10, whereas the framework uses DEFAULT_MAX_STEPS = 50 (resolved via default_max_steps(), overridable by GAIA_AGENT_MAX_STEPS).

Changes

  • Updated docs/sdk/core/agent-system.mdx to reflect the default value of 50 and reference DEFAULT_MAX_STEPS and GAIA_AGENT_MAX_STEPS.
  • Updated docs/spec/chat-agent.mdx to reference default_max_steps() (DEFAULT_MAX_STEPS = 50).

Checklist

  • I have read the CONTRIBUTING doc
  • Tests pass locally

Signed-off-by: Aman Awasthi <amandeavor@gmail.com>
Copilot AI balanced review requested due to automatic review settings October 25, 2026 07:48

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@github-actions github-actions Bot added the documentation Documentation changes label Oct 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Verdict: Approve

The SDK guide said agents stop after 20 reasoning steps by default, and the ChatAgent spec said 10. The real default is 50. This PR corrects all four places, and each new value matches the code. Nothing blocks the merge.

Real-world evidence

N/A: this PR changes docs only. No runnable surface changed, so the verdict rests on reading the diff against the source.

🔍 Technical details

Verified against source

  • DEFAULT_MAX_STEPS = 50 and default_max_steps() (which reads GAIA_AGENT_MAX_STEPS) are in src/gaia/agents/base/agent.py:232 and :390. Agent.__init__ falls back to it at :2419.
  • ChatAgentConfig.max_steps: int = field(default_factory=default_max_steps) in hub/agents/chat/python/gaia_agent_chat/agent.py:285 is exactly what the spec snippet now shows.

Issues found

  • 🟢 Optional: mention the flagship's cap (docs/sdk/core/agent-system.mdx:911). GaiaAgent overrides the default with FLAGSHIP_MAX_STEPS (150, per the gaia CLI help). A reader who sees "50" here may assume the flagship stops at 50 too. One clause such as "the flagship uses 150" would prevent that. Not required for this PR.

Strengths

  • The fix is tightly scoped to the issue, and every corrected value matches the code.
  • The ChatAgent spec snippet now uses the real default_factory, so it can't drift from the env-var override again.

@kovtcharov-amd
kovtcharov-amd added this pull request to the merge queue Oct 26, 2026
Merged via the queue into amd:main with commit 5b842d9 Oct 26, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(sdk): max_steps default documented as 20, the framework uses 50

3 participants