Struct ToolContext 

pub struct ToolContext {
    pub tool_call_id: ToolCallId,
    pub messages: Arc<[Message]>,
    pub cancellation: CancellationToken,
    pub tools_context: Option<JsonValue>,
    pub sandbox: Option<Arc<dyn Sandbox>>,
}

Per-call information handed to a tool execution.

Fields

tool_call_id: ToolCallId

Id of the tool call being executed.

messages: Arc<[Message]>

Messages sent to the model for the step that produced the call (without the system prompt and without the assistant response).

cancellation: CancellationToken

Cancels the execution.

tools_context: Option<JsonValue>

This tool’s selected context, validated when it declares a context schema.

sandbox: Option<Arc<dyn Sandbox>>

Sandbox the tool operates in.

Implementations

impl ToolContext

pub fn new(tool_call_id: impl Into<ToolCallId>) -> Self

Creates a context with no messages, a fresh token and no tool context.

pub fn with_messages(self, messages: impl Into<Arc<[Message]>>) -> Self

Sets the step messages.

pub fn with_cancellation(self, cancellation: CancellationToken) -> Self

Sets the cancellation token.

pub fn with_tools_context(self, tools_context: Option<JsonValue>) -> Self

Sets the validated tool context.

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

Sets the sandbox.

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.