docs(sdk): Update built-in subagents documentation to match current implementation#442
Open
VascoSch92 wants to merge 4 commits intomainfrom
Open
docs(sdk): Update built-in subagents documentation to match current implementation#442VascoSch92 wants to merge 4 commits intomainfrom
VascoSch92 wants to merge 4 commits intomainfrom
Conversation
- Update agent names from deprecated to current: - default → general-purpose - explore → code-explorer - bash → bash-runner - Add missing web-researcher agent documentation - Remove non-existent 'default cli mode' agent - Fix tools list for general-purpose (no browser_tool_set) - Update register_builtins_agents() parameter from cli_mode to enable_browser - Add deprecation notice for legacy agent names Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
VascoSch92
commented
Apr 8, 2026
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: OpenHands Bot <contact@all-hands.dev>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Address PR review feedback: include 'default cli mode' in the deprecation notice since it's a valid deprecated name that maps to 'general-purpose'. Also added the deprecation version (v1.12.0) for clarity. Co-authored-by: openhands <openhands@all-hands.dev>
all-hands-bot
approved these changes
Apr 8, 2026
Contributor
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Documentation now matches reality. All claims verified against source code.
Verified:
- Agent names: ✓ general-purpose, code-explorer, bash-runner, web-researcher
- Tools lists: ✓ Match actual subagent definitions in
openhands-tools/openhands/tools/preset/subagents/*.md - Function signature: ✓
enable_browserparameter correct perdefault.py - Deprecation: ✓ v1.12.0 + all 4 names in registry
Key Insight: This is how documentation should be maintained—verified against source code, not speculation. Ship it.
VascoSch92
changed the title
all-hands-bot
approved these changes
Apr 8, 2026
Contributor
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Documentation maintenance done right.
Verified against source code:
- Agent names: ✓ All match actual files (
general-purpose,code-explorer,bash-runner,web-researcher) - Tools lists: ✓ Match subagent definitions exactly (
default.md,bash_runner.md,code_explorer.md,web_researcher.md) - Function signature: ✓
enable_browserparameter confirmed indefault.py - Deprecation: ✓ Version 1.12.0 and all 4 names (
default,default cli mode,explore,bash) confirmed inregistry.py
KEY INSIGHT: This is pragmatic engineering—fixing documentation to match reality, not the other way around. No theoretical debates, no bikeshedding, just making the docs accurate.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the built-in subagents documentation in
sdk/guides/agent-file-based.mdxto match the current SDK implementation.Changes
Agent Names Updated
The documentation was using deprecated agent names. Updated to current names:
defaultgeneral-purposeexplorecode-explorerbashbash-runnerAdded Missing Agent
web-researcheragent which was completely missing from the docsRemoved Non-Existent Agent
default cli modewhich doesn't exist as a separate agent fileFixed Tools List
general-purpose: now showsterminal,file_editor,task_tracker(withoutbrowser_tool_set)Fixed Function Signature
register_builtins_agents()parameter fromcli_modetoenable_browserto match actual implementationAdded Deprecation Notice
Verification
Checked against the actual implementation in
software-agent-sdk:openhands-tools/openhands/tools/preset/subagents/*.md- actual subagent definitionsopenhands-tools/openhands/tools/preset/default.py-register_builtins_agents()functionopenhands-sdk/openhands/sdk/subagent/registry.py- deprecated name mappingsThis PR was created by an AI assistant (OpenHands) on behalf of the user.
@VascoSch92 can click here to continue refining the PR