Struct ChatToolCallAuthRequiredAction 

pub struct ChatToolCallAuthRequiredAction {
    pub turn_id: String,
    pub tool_call_id: String,
    pub meta: Option<JsonObject>,
    pub auth: McpAuthRequirement,
}

A running tool call is paused pending MCP authentication. Transitions the tool call from running to auth-required.

The server dispatches this when the MCP server backing the call responds with a 401/403 challenge mid-execution (see {@link McpAuthRequirement.reason | insufficientScope}). The host SHOULD pair this with session/inputNeededSet (kind toolAuthentication) so the block is visible at the session-summary level, mirroring {@link McpServerAuthRequiredState}’s own InputNeeded guidance.

Only valid for tool calls contributed by an MCP server — the reducer is a no-op if the tool call’s contributor is not {@link ToolCallContributorKind.MCP | MCP-kind}.

Fields

turn_id: String

Turn identifier

tool_call_id: String

Tool call identifier

meta: Option<JsonObject>

Additional provider-specific metadata for this tool call.

Clients MAY look for well-known keys here to provide enhanced UI. For example, a ptyTerminal key with { input: string; output: string } indicates the tool operated on a terminal (both input and output may contain escape sequences).

auth: McpAuthRequirement

The authentication challenge blocking this invocation.

Trait Implementations

impl Clone for ChatToolCallAuthRequiredAction

fn clone(&self) -> ChatToolCallAuthRequiredAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatToolCallAuthRequiredAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatToolCallAuthRequiredAction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatToolCallAuthRequiredAction

fn eq(&self, other: &ChatToolCallAuthRequiredAction) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ChatToolCallAuthRequiredAction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChatToolCallAuthRequiredAction