From c5361765158657a82b8a94cfb5d128aa2165c43f Mon Sep 17 00:00:00 2001 From: xingyaoww <38853559+xingyaoww@users.noreply.github.com> Date: Thu, 6 Nov 2025 15:34:54 +0000 Subject: [PATCH] docs: sync code blocks from agent-sdk examples Synced from agent-sdk ref: main --- sdk/getting-started.mdx | 4 ++-- sdk/guides/agent-browser-use.mdx | 4 ++-- sdk/guides/agent-interactive-terminal.mdx | 4 ++-- sdk/guides/context-condenser.mdx | 4 ++-- sdk/guides/convo-async.mdx | 4 ++-- sdk/guides/convo-pause-and-resume.mdx | 4 ++-- sdk/guides/convo-persistence.mdx | 4 ++-- sdk/guides/convo-send-message-while-running.mdx | 4 ++-- sdk/guides/custom-tools.mdx | 12 ++++++------ sdk/guides/hello-world.mdx | 4 ++-- sdk/guides/llm-image-input.mdx | 4 ++-- sdk/guides/llm-reasoning.mdx | 4 ++-- sdk/guides/llm-registry.mdx | 4 ++-- sdk/guides/mcp.mdx | 8 ++++---- sdk/guides/metrics.mdx | 12 ++++++------ sdk/guides/secrets.mdx | 4 ++-- sdk/guides/security.mdx | 4 ++-- sdk/guides/skill.mdx | 4 ++-- 18 files changed, 46 insertions(+), 46 deletions(-) diff --git a/sdk/getting-started.mdx b/sdk/getting-started.mdx index a706b53b..e0d608cc 100644 --- a/sdk/getting-started.mdx +++ b/sdk/getting-started.mdx @@ -75,9 +75,9 @@ Here's a complete example that creates an agent and asks it to perform a simple import os from openhands.sdk import LLM, Agent, Conversation, Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool from openhands.tools.task_tracker import TaskTrackerTool +from openhands.tools.terminal import TerminalTool llm = LLM( @@ -88,7 +88,7 @@ llm = LLM( agent = Agent( llm=llm, tools=[ - Tool(name=BashTool.name), + Tool(name=TerminalTool.name), Tool(name=FileEditorTool.name), Tool(name=TaskTrackerTool.name), ], diff --git a/sdk/guides/agent-browser-use.mdx b/sdk/guides/agent-browser-use.mdx index 3a16a5e3..d9d73042 100644 --- a/sdk/guides/agent-browser-use.mdx +++ b/sdk/guides/agent-browser-use.mdx @@ -24,8 +24,8 @@ from openhands.sdk import ( ) from openhands.sdk.tool import Tool from openhands.tools.browser_use import BrowserToolSet -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -46,7 +46,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), Tool(name=BrowserToolSet.name), diff --git a/sdk/guides/agent-interactive-terminal.mdx b/sdk/guides/agent-interactive-terminal.mdx index 26c8e9b1..a855c7a3 100644 --- a/sdk/guides/agent-interactive-terminal.mdx +++ b/sdk/guides/agent-interactive-terminal.mdx @@ -24,7 +24,7 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -45,7 +45,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, params={"no_change_timeout_seconds": 3}, ) ] diff --git a/sdk/guides/context-condenser.mdx b/sdk/guides/context-condenser.mdx index 991921cf..ee35cd4b 100644 --- a/sdk/guides/context-condenser.mdx +++ b/sdk/guides/context-condenser.mdx @@ -77,9 +77,9 @@ from openhands.sdk import ( ) from openhands.sdk.context.condenser import LLMSummarizingCondenser from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool from openhands.tools.task_tracker import TaskTrackerTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -100,7 +100,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), Tool(name=TaskTrackerTool.name), diff --git a/sdk/guides/convo-async.mdx b/sdk/guides/convo-async.mdx index 531804d1..79a96785 100644 --- a/sdk/guides/convo-async.mdx +++ b/sdk/guides/convo-async.mdx @@ -32,9 +32,9 @@ from openhands.sdk import ( from openhands.sdk.conversation.types import ConversationCallbackType from openhands.sdk.tool import Tool from openhands.sdk.utils.async_utils import AsyncCallbackWrapper -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool from openhands.tools.task_tracker import TaskTrackerTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -55,7 +55,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), Tool(name=TaskTrackerTool.name), diff --git a/sdk/guides/convo-pause-and-resume.mdx b/sdk/guides/convo-pause-and-resume.mdx index 007144d9..a45975b6 100644 --- a/sdk/guides/convo-pause-and-resume.mdx +++ b/sdk/guides/convo-pause-and-resume.mdx @@ -23,8 +23,8 @@ from openhands.sdk import ( Conversation, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool # Configure LLM @@ -42,7 +42,7 @@ llm = LLM( # Tools tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), ] diff --git a/sdk/guides/convo-persistence.mdx b/sdk/guides/convo-persistence.mdx index 99d95811..da6ddd27 100644 --- a/sdk/guides/convo-persistence.mdx +++ b/sdk/guides/convo-persistence.mdx @@ -24,8 +24,8 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -45,7 +45,7 @@ llm = LLM( # Tools cwd = os.getcwd() tools = [ - Tool(name=BashTool.name), + Tool(name=TerminalTool.name), Tool(name=FileEditorTool.name), ] diff --git a/sdk/guides/convo-send-message-while-running.mdx b/sdk/guides/convo-send-message-while-running.mdx index 1cc7cc6c..78953438 100644 --- a/sdk/guides/convo-send-message-while-running.mdx +++ b/sdk/guides/convo-send-message-while-running.mdx @@ -63,8 +63,8 @@ from openhands.sdk import ( Conversation, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool # Configure LLM @@ -83,7 +83,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), ] diff --git a/sdk/guides/custom-tools.mdx b/sdk/guides/custom-tools.mdx index 58efa1b6..c9ae37c5 100644 --- a/sdk/guides/custom-tools.mdx +++ b/sdk/guides/custom-tools.mdx @@ -66,12 +66,12 @@ from openhands.sdk.tool import ( ToolExecutor, register_tool, ) -from openhands.tools.execute_bash import ( +from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import ( BashExecutor, - BashTool, ExecuteBashAction, + TerminalTool, ) -from openhands.tools.file_editor import FileEditorTool logger = get_logger(__name__) @@ -210,11 +210,11 @@ cwd = os.getcwd() def _make_bash_and_grep_tools(conv_state) -> list[ToolDefinition]: - """Create execute_bash and custom grep tools sharing one executor.""" + """Create terminal and custom grep tools sharing one executor.""" bash_executor = BashExecutor(working_dir=conv_state.workspace.working_dir) - # bash_tool = execute_bash_tool.set_executor(executor=bash_executor) - bash_tool = BashTool.create(conv_state, executor=bash_executor)[0] + # bash_tool = terminal_tool.set_executor(executor=bash_executor) + bash_tool = TerminalTool.create(conv_state, executor=bash_executor)[0] # Use the GrepTool.create() method with shared bash_executor grep_tool = GrepTool.create(conv_state, bash_executor=bash_executor)[0] diff --git a/sdk/guides/hello-world.mdx b/sdk/guides/hello-world.mdx index ca1ef62c..5aa8485a 100644 --- a/sdk/guides/hello-world.mdx +++ b/sdk/guides/hello-world.mdx @@ -13,9 +13,9 @@ This is the most basic example showing how to set up and run an OpenHands agent: import os from openhands.sdk import LLM, Agent, Conversation, Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool from openhands.tools.task_tracker import TaskTrackerTool +from openhands.tools.terminal import TerminalTool llm = LLM( @@ -26,7 +26,7 @@ llm = LLM( agent = Agent( llm=llm, tools=[ - Tool(name=BashTool.name), + Tool(name=TerminalTool.name), Tool(name=FileEditorTool.name), Tool(name=TaskTrackerTool.name), ], diff --git a/sdk/guides/llm-image-input.mdx b/sdk/guides/llm-image-input.mdx index ddd761d1..3c896f21 100644 --- a/sdk/guides/llm-image-input.mdx +++ b/sdk/guides/llm-image-input.mdx @@ -32,9 +32,9 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool.spec import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool from openhands.tools.task_tracker import TaskTrackerTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -58,7 +58,7 @@ agent = Agent( llm=llm, tools=[ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), Tool(name=TaskTrackerTool.name), diff --git a/sdk/guides/llm-reasoning.mdx b/sdk/guides/llm-reasoning.mdx index 2273ed82..88482524 100644 --- a/sdk/guides/llm-reasoning.mdx +++ b/sdk/guides/llm-reasoning.mdx @@ -33,7 +33,7 @@ from openhands.sdk import ( ThinkingBlock, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool +from openhands.tools.terminal import TerminalTool # Configure LLM for Anthropic Claude with extended thinking @@ -50,7 +50,7 @@ llm = LLM( ) # Setup agent with bash tool -agent = Agent(llm=llm, tools=[Tool(name=BashTool.name)]) +agent = Agent(llm=llm, tools=[Tool(name=TerminalTool.name)]) # Callback to display thinking blocks diff --git a/sdk/guides/llm-registry.mdx b/sdk/guides/llm-registry.mdx index 2538bf0b..70b002b7 100644 --- a/sdk/guides/llm-registry.mdx +++ b/sdk/guides/llm-registry.mdx @@ -26,7 +26,7 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -54,7 +54,7 @@ llm = llm_registry.get("agent") # Tools cwd = os.getcwd() -tools = [Tool(name=BashTool.name)] +tools = [Tool(name=TerminalTool.name)] # Agent agent = Agent(llm=llm, tools=tools) diff --git a/sdk/guides/mcp.mdx b/sdk/guides/mcp.mdx index f5c2a35f..32b5c1af 100644 --- a/sdk/guides/mcp.mdx +++ b/sdk/guides/mcp.mdx @@ -29,8 +29,8 @@ from openhands.sdk import ( ) from openhands.sdk.security.llm_analyzer import LLMSecurityAnalyzer from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -49,7 +49,7 @@ llm = LLM( cwd = os.getcwd() tools = [ - Tool(name=BashTool.name), + Tool(name=TerminalTool.name), Tool(name=FileEditorTool.name), ] @@ -161,8 +161,8 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -182,7 +182,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), ] diff --git a/sdk/guides/metrics.mdx b/sdk/guides/metrics.mdx index 789270b0..6d9393a6 100644 --- a/sdk/guides/metrics.mdx +++ b/sdk/guides/metrics.mdx @@ -31,8 +31,8 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -51,7 +51,7 @@ llm = LLM( cwd = os.getcwd() tools = [ - Tool(name=BashTool.name), + Tool(name=TerminalTool.name), Tool(name=FileEditorTool.name), ] @@ -159,7 +159,7 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -187,7 +187,7 @@ llm = llm_registry.get("agent") # Tools cwd = os.getcwd() -tools = [Tool(name=BashTool.name)] +tools = [Tool(name=TerminalTool.name)] # Agent agent = Agent(llm=llm, tools=tools) @@ -276,7 +276,7 @@ from openhands.sdk import ( get_logger, ) from openhands.sdk.tool.spec import Tool -from openhands.tools.execute_bash import BashTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -310,7 +310,7 @@ agent = Agent( llm=llm, tools=[ Tool( - name=BashTool.name, + name=TerminalTool.name, ), ], condenser=condenser, diff --git a/sdk/guides/secrets.mdx b/sdk/guides/secrets.mdx index 6d33392e..0a1b413e 100644 --- a/sdk/guides/secrets.mdx +++ b/sdk/guides/secrets.mdx @@ -21,8 +21,8 @@ from openhands.sdk import ( ) from openhands.sdk.conversation.secret_source import SecretSource from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool # Configure LLM @@ -39,7 +39,7 @@ llm = LLM( # Tools tools = [ - Tool(name=BashTool.name), + Tool(name=TerminalTool.name), Tool(name=FileEditorTool.name), ] diff --git a/sdk/guides/security.mdx b/sdk/guides/security.mdx index c87aaf77..54b68764 100644 --- a/sdk/guides/security.mdx +++ b/sdk/guides/security.mdx @@ -249,8 +249,8 @@ from openhands.sdk.conversation.state import ( from openhands.sdk.security.confirmation_policy import ConfirmRisky from openhands.sdk.security.llm_analyzer import LLMSecurityAnalyzer from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool # Clean ^C exit: no stack trace noise @@ -337,7 +337,7 @@ llm = LLM( # Tools tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), ] diff --git a/sdk/guides/skill.mdx b/sdk/guides/skill.mdx index 1d301c29..dcfae816 100644 --- a/sdk/guides/skill.mdx +++ b/sdk/guides/skill.mdx @@ -28,8 +28,8 @@ from openhands.sdk.context import ( Skill, ) from openhands.sdk.tool import Tool -from openhands.tools.execute_bash import BashTool from openhands.tools.file_editor import FileEditorTool +from openhands.tools.terminal import TerminalTool logger = get_logger(__name__) @@ -50,7 +50,7 @@ llm = LLM( cwd = os.getcwd() tools = [ Tool( - name=BashTool.name, + name=TerminalTool.name, ), Tool(name=FileEditorTool.name), ]