Struct ToolContext 

pub struct ToolContext<'a> {
    pub tool_call_id: &'a str,
    pub args: Value,
    pub llm: Option<&'a AgentLlmConfig>,
    pub provider: Option<Arc<dyn LlmProvider>>,
    pub working_dir: Option<&'a PathBuf>,
    /* private fields */
}

Per-invocation context passed to Tool::execute methods.

Carries everything a tool needs: the call ID for building results, raw JSON arguments, cancellation support, and the working directory for path resolution.

Key fields

Field	Purpose
tool_call_id	Echo into ToolResult::tool_call_id so results match calls
args	Raw JSON arguments sent by the LLM — parse with parse_args
working_dir	Chat workspace root; relative paths resolve against this

Fields

tool_call_id: &'a str

The unique ID for this tool call. Echo into ToolResult::tool_call_id when returning.

args: Value

Raw JSON arguments from the LLM. Use parse_args to deserialize.

llm: Option<&'a AgentLlmConfig>

Current parent configuration, including its cache routing identity.

provider: Option<Arc<dyn LlmProvider>>

Current provider for tools that delegate model requests.

working_dir: Option<&'a PathBuf>

Working directory for the current agent (typically chat workspace). Relative paths resolve here.

Implementations

impl<'a> ToolContext<'a>

pub fn new( tool_call_id: &'a str, args: Value, working_dir: Option<&'a PathBuf>, cancel_token: &'a CancellationToken, ) -> Self

Create a new tool execution context.

pub fn with_llm(self, llm: &'a AgentLlmConfig) -> Self

Pass the current agent configuration to the tool.

pub fn with_provider(self, provider: Arc<dyn LlmProvider>) -> Self

Pass the current provider to tools that delegate model requests.

pub fn with_progress(self, tx: UnboundedSender<String>) -> Self

Attach a progress channel for streaming incremental output.

pub fn with_background_request(self, request: &'a BackgroundRequest) -> Self

Attach the user’s control for backgrounding this running call.

pub fn background_request(&self) -> Option<&BackgroundRequest>

pub fn progress_sender(&self) -> Option<UnboundedSender<String>>

Clone the live output destination when execution moves to an owned task.

pub fn progress(&self, line: &str)

Send a progress line through the channel (no-op if no channel is set).

pub fn parse_args<T: DeserializeOwned>(&self, tool_name: &str) -> Result<T>

Parse the raw JSON args into a typed struct. Fails with a descriptive error if invalid.

pub fn cancel_token(&self) -> &CancellationToken

Access the cancellation token for cooperative cancellation checks.

For long-running operations, prefer child_token to get a derived token that can be passed to async sub-operations.

pub fn child_token(&self) -> CancellationToken

Create a child cancellation token. Cancels when the parent turn is cancelled. Use this for spawned tasks so they’re automatically cancelled when the user aborts.