Struct SessionRpcMcpOauth 

pub struct SessionRpcMcpOauth<'a> { /* private fields */ }

session.mcp.oauth.* RPCs.

Implementations

impl<'a> SessionRpcMcpOauth<'a>

pub async fn handle_pending_request( &self, params: McpOauthHandlePendingRequest, ) -> Result<McpOauthHandlePendingResult, Error>

Resolves a pending MCP OAuth request with a host-provided token or cancellation. The pending request is emitted as mcp.oauth_required with the data necessary to authorize the request.

Wire method: session.mcp.oauth.handlePendingRequest.

Parameters

• params - Pending MCP OAuth request ID and host-provided token or cancellation response.

Returns

Indicates whether the pending MCP OAuth response was accepted.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn authentication_state_changed( &self, params: McpOauthAuthenticationStateChangedRequest, ) -> Result<(), Error>

Notifies the session that MCP OAuth authentication succeeded and updated credentials were persisted, so cached tool definitions can be refreshed.

Wire method: session.mcp.oauth.authenticationStateChanged.

Parameters

• params - Identifies the MCP server whose persisted OAuth credentials were updated.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn login( &self, params: McpOauthLoginRequest, ) -> Result<McpOauthLoginResult, Error>

Starts OAuth authentication for a remote MCP server.

Wire method: session.mcp.oauth.login.

Parameters

• params - Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.

Returns

OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn probe( &self, params: McpOauthProbeRequest, ) -> Result<McpOauthProbeResult, Error>

Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted. Does not start OAuth, emit pending OAuth requests, or mutate MCP connection state.

Wire method: session.mcp.oauth.probe.

Parameters

• params - Remote MCP server name for a passive OAuth status probe.

Returns

Passive MCP OAuth probe result. authenticated means the server accepted the probe request while an OAuth-origin access token was attached; it does not prove the server required or independently validated that token. The probe does not make a second unauthenticated request. Failed is an expected probe-domain outcome; JSON-RPC errors are reserved for API-call failures.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn respond( &self, params: McpOauthRespondRequest, ) -> Result<McpOauthRespondResult, Error>

Responds to a pending MCP OAuth authorization request by its request id.

Wire method: session.mcp.oauth.respond.

Parameters

• params - Pending MCP OAuth request id to respond to.

Returns

Indicates whether the pending MCP OAuth response was accepted.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Trait Implementations

impl<'a> Clone for SessionRpcMcpOauth<'a>

fn clone(&self) -> SessionRpcMcpOauth<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for SessionRpcMcpOauth<'a>