Struct ToolContext 

pub struct ToolContext {
    pub workspace: PathBuf,
    pub session_id: Option<String>,
    pub event_tx: Option<ToolEventSender>,
    pub agent_event_tx: Option<Sender<AgentEvent>>,
    pub search_config: Option<Arc<SearchConfig>>,
    pub sandbox: Option<Arc<dyn BashSandbox>>,
    pub command_env: Option<Arc<HashMap<String, String>>>,
    pub workspace_services: Arc<WorkspaceServices>,
}

Tool execution context

Provides tools with access to workspace and other runtime information.

Fields

workspace: PathBuf

Workspace root directory (sandbox boundary)

session_id: Option<String>

Optional session ID for session-aware tools

event_tx: Option<ToolEventSender>

Optional sender for streaming tool output deltas during execution

agent_event_tx: Option<Sender<AgentEvent>>

Optional agent event sender for tools that emit high-level agent events (e.g., SubagentStart)

search_config: Option<Arc<SearchConfig>>

Optional search configuration for web_search tool

sandbox: Option<Arc<dyn BashSandbox>>

Optional sandbox for routing bash tool execution through A3S Box.

command_env: Option<Arc<HashMap<String, String>>>

Optional command environment overrides for subprocess-based tools.

workspace_services: Arc<WorkspaceServices>

Host-provided workspace capabilities used by built-in tools.

Implementations

impl ToolContext

pub fn new(workspace: PathBuf) -> Self

pub fn with_session_id(self, session_id: impl Into<String>) -> Self

Set the session ID for this context

pub fn with_event_tx(self, tx: ToolEventSender) -> Self

Set the event sender for streaming tool output

pub fn with_agent_event_tx(self, tx: Sender<AgentEvent>) -> Self

Set the agent event sender for high-level agent events (e.g., SubagentStart/End)

pub fn with_search_config(self, config: SearchConfig) -> Self

Set the search configuration

pub fn with_sandbox(self, sandbox: Arc<dyn BashSandbox>) -> Self

Set a sandbox executor for the bash tool.

pub fn with_command_env(self, env: Arc<HashMap<String, String>>) -> Self

Set environment overrides for subprocess-based tools such as bash.

pub fn with_workspace_services(self, services: Arc<WorkspaceServices>) -> Self

Set host-provided workspace capabilities for built-in tools.

pub fn resolve_workspace_path(&self, path: &str) -> Result<WorkspacePath>

Normalize a user-supplied path through the configured workspace backend.

pub fn resolve_path(&self, path: &str) -> Result<PathBuf>

👎Deprecated:

Use resolve_workspace_path() and route I/O through workspace_services.fs() for non-local backends

Resolve path relative to workspace, ensuring it stays within sandbox.

Deprecated: returns a host-filesystem PathBuf that is meaningless for virtual / DFS / browser workspace backends. New code should call Self::resolve_workspace_path and route I/O through workspace_services.fs() instead.

pub fn resolve_path_for_write(&self, path: &str) -> Result<PathBuf>

👎Deprecated:

Use resolve_workspace_path() and route I/O through workspace_services.fs() for non-local backends

Resolve path for writing (allows non-existent files).

Deprecated: see Self::resolve_path.

Trait Implementations

impl Clone for ToolContext

fn clone(&self) -> ToolContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.