Skip to content

fix(shell-execute): optimize working_directory parameter and tool usage hints #2107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jujn merged 3 commits into from
Jul 18, 2026
+10 −4
Merged

fix(shell-execute): optimize working_directory parameter and tool usage hints #2107

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8b993b
refactor(tool): Add the required attribute to the working_directory p…
chcodex Jul 10, 2026
791602e
fix(agent): Optimize workingDirectory parameter description
chcodex Jul 10, 2026
e470681
docs(shell-execute): clearly prompts that when special tools (such as…
chcodex Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions agentscope-harness/src/main/java/io/agentscope/harness/agent/tool/ShellExecuteTool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
*/
public class ShellExecuteTool {

/** Registered tool name (derived from the {@link #execute} method name). */
/**
* Registered tool name (derived from the {@link #execute} method name).
*/
public static final String NAME = "execute";

private final AbstractSandboxFilesystem sandbox;
Expand All @@ -37,19 +39,23 @@ public ShellExecuteTool(AbstractSandboxFilesystem sandbox) {

/**
* @param runtimeContext per-call agent runtime injected by the framework (not an LLM argument);
* may be {@code null} when no merged context is available
* may be {@code null} when no merged context is available
*/
@Tool(
description =
"Execute a shell command. Use for git, npm, build, test, and other terminal"
+ " operations. Returns combined output and exit code.")
+ " operations. Returns combined output and exit code. If a dedicated tool"
+ " exists (e.g., read_file, write_file), you MUST use it instead of shell"
+ " commands.")
public String execute(
RuntimeContext runtimeContext,
@ToolParam(name = "command", description = "Shell command to execute") String command,
@ToolParam(
name = "working_directory",
description =
"Working directory (relative to workspace root, optional)")
"Optional relative path from workspace root. Must not start"
+ " with /, ~, or ..(e.g., ., src).",
required = false)
String workingDirectory,
@ToolParam(name = "timeout", description = "Timeout in seconds (default: 30)")
int timeout) {
Expand Down
Loading