Struct BashTool 

pub struct BashTool { /* private fields */ }

Runs a shell command in the workspace root with a timeout.

Streams stdout and stderr line-by-line via ToolContext::emit_progress so UI layers can display live terminal output. The final result contains stdout and stderr, each capped at Workspace::max_output bytes; output past the cap is read and discarded, so memory stays bounded.

Cancelling the call (dropping its future) kills the command and every process it started, as a timeout does.

Implementations

impl BashTool

pub fn new(workspace: Workspace) -> Self

Create a bash tool bound to workspace.

Trait Implementations

impl Tool for BashTool

fn name(&self) -> &str

Returns the unique name of this tool.

fn description(&self) -> &str

Returns a human-readable description of what this tool does.

fn parameters_schema(&self) -> Option<Value>

Returns the JSON Schema for this tool’s parameters, if any.

fn execute<'life0, 'async_trait>( &'life0 self, ctx: Arc<dyn ToolContext>, args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes the tool with the given context and arguments.

fn declaration(&self) -> Value

Returns the tool declaration that should be exposed to model providers.

fn enhanced_description(&self) -> String

Returns an enhanced description that may include additional notes. For long-running tools, this includes a warning not to call the tool again if it has already returned a pending status. Default implementation returns the base description.

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.

fn is_builtin(&self) -> bool

Indicates whether this tool is a built-in server-side tool (e.g., google_search, url_context).

fn response_schema(&self) -> Option<Value>

Returns the JSON Schema for this tool’s response, if any.

fn required_scopes(&self) -> &[&str]

Returns the scopes required to execute this tool.

fn is_read_only(&self) -> bool

Indicates whether this tool performs no side effects.

fn is_concurrency_safe(&self) -> bool

Indicates whether this tool is safe for concurrent execution.

fn is_agent_delegation(&self) -> bool

Indicates whether this tool delegates work to another agent.