Struct ToolInvocation 

#[non_exhaustive]
pub struct ToolInvocation {
    pub session_id: SessionId,
    pub tool_call_id: String,
    pub tool_name: String,
    pub arguments: Value,
    pub traceparent: Option<String>,
    pub tracestate: Option<String>,
}

A request from the CLI to invoke a client-defined tool.

Received as a JSON-RPC request on the tool.call method. The client must respond with a ToolResultResponse.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: SessionId

Session that owns this tool call.

tool_call_id: String

Unique ID for this tool call, used to correlate the response.

tool_name: String

Name of the tool being invoked.

arguments: Value

Tool arguments as JSON.

traceparent: Option<String>

W3C Trace Context traceparent header propagated from the CLI’s execute_tool span. Pass through to OpenTelemetry-aware code so child spans created inside the handler are parented to the CLI span. None when the CLI has no trace context for this call.

tracestate: Option<String>

W3C Trace Context tracestate paired with traceparent.

Implementations

impl ToolInvocation

pub fn params<P: DeserializeOwned>(&self) -> Result<P, Error>

Deserialize this invocation’s arguments into a strongly-typed parameter struct.

Idiomatic way to extract typed parameters when implementing ToolHandler directly. Equivalent to serde_json::from_value(invocation.arguments.clone()) with the SDK’s error type.

Example

let params: MyParams = inv.params()?;
// …use `inv.session_id` / `inv.tool_call_id` alongside `params`…

pub fn trace_context(&self) -> TraceContext

Returns the propagated TraceContext for this invocation, or TraceContext::default() when the CLI sent no headers.

Trait Implementations

impl Clone for ToolInvocation

fn clone(&self) -> ToolInvocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInvocation

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

Formats the value using the given formatter.

impl Default for ToolInvocation

fn default() -> ToolInvocation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolInvocation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolInvocation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.