Skip to content

Commit 3485188

Browse files
VascoSch92openhands-agentall-hands-bot
authored
docs(sdk): Update built-in subagents documentation to match current implementation (#442)
* docs: update built-in subagents to match current implementation - 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> * Apply suggestion from @VascoSch92 * Update sdk/guides/agent-file-based.mdx Co-authored-by: OpenHands Bot <contact@all-hands.dev> * docs: add missing 'default cli mode' to deprecation notice 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> --------- Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: OpenHands Bot <contact@all-hands.dev>
1 parent 51139f6 commit 3485188

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

sdk/guides/agent-file-based.mdx

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,20 @@ By default, all agents include `finish` tool and the `think` tool.
116116

117117
| Agent | Tools | Description |
118118
|--------|-------|-------|
119-
| **default** | `terminal`, `file_editor`, `task_tracker`, `browser_tool_set` | General-purpose agent. Used as the fallback when no agent name is specified. |
120-
| **default cli mode** | `terminal`, `file_editor`, `task_tracker` | Same as `default` but without browser tools (used in CLI mode). |
121-
| **explore** | `terminal` | Read-only codebase exploration agent. Finds files, searches code, reads source — never creates or modifies anything. |
122-
| **bash** | `terminal` | Command execution specialist. Runs shell commands, builds, tests, and git operations. |
119+
| **general-purpose** | `terminal`, `file_editor`, `task_tracker` | General-purpose agent for tasks requiring a combination of capabilities. Used as the fallback when no agent name is specified. |
120+
| **code-explorer** | `terminal` | Read-only codebase exploration agent. Finds files, searches code, reads source — never creates or modifies anything. |
121+
| **bash-runner** | `terminal` | Command execution specialist. Runs shell commands, builds, tests, linters, and git operations. Returns concise reports instead of raw output. |
122+
| **web-researcher** | `browser_tool_set` + MCP (`fetch`, `tavily`) | Web research specialist. Searches the web, navigates documentation, and extracts information from URLs. |
123123

124-
In CLI mode, the `default` agent (with browser tools) is replaced by the `default cli mode` agent. In non-CLI mode, `default cli mode` is filtered out.
124+
When `enable_browser=False`, browser-dependent agents like `web-researcher` are not registered.
125+
126+
<Note>
127+
**Deprecated names:** The following legacy names are deprecated (since v1.12.0) and will be removed in version 2.0.0:
128+
- `default` → use `general-purpose`
129+
- `default cli mode` → use `general-purpose`
130+
- `explore` → use `code-explorer`
131+
- `bash` → use `bash-runner`
132+
</Note>
125133

126134
### Registering Built-in Sub-Agents
127135

@@ -130,11 +138,11 @@ Call `register_builtins_agents()` to register all built-in sub-agents. This is t
130138
```python icon="python" focus={3-4, 6-7}
131139
from openhands.tools.preset.default import register_builtins_agents
132140

133-
# Register built-in sub-agents (default, explore, bash)
141+
# Register all built-in sub-agents (including web-researcher)
134142
register_builtins_agents()
135143

136-
# Or in CLI mode (swaps default for default cli mode — no browser)
137-
register_builtins_agents(cli_mode=True)
144+
# Or without browser-dependent agents (excludes web-researcher)
145+
register_builtins_agents(enable_browser=False)
138146
```
139147

140148
<Warning>

0 commit comments

Comments
 (0)