Skip to main content

SessionRpcMcp

Struct SessionRpcMcp 

Source
pub struct SessionRpcMcp<'a> { /* private fields */ }
Expand description

session.mcp.* RPCs.

Implementations§

Source§

impl<'a> SessionRpcMcp<'a>

Source

pub fn oauth(&self) -> SessionRpcMcpOauth<'a>

session.mcp.oauth.* sub-namespace.

Source

pub async fn list(&self) -> Result<McpServerList, Error>

Lists MCP servers configured for the session and their connection status.

Wire method: session.mcp.list.

§Returns

MCP servers configured for the session, with their connection status.

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.

Source

pub async fn enable(&self, params: McpEnableRequest) -> Result<(), Error>

Enables an MCP server for the session.

Wire method: session.mcp.enable.

§Parameters
  • params - Name of the MCP server to enable for the session.

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.

Source

pub async fn disable(&self, params: McpDisableRequest) -> Result<(), Error>

Disables an MCP server for the session.

Wire method: session.mcp.disable.

§Parameters
  • params - Name of the MCP server to disable for the session.

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.

Source

pub async fn reload(&self) -> Result<(), Error>

Reloads MCP server connections for the session.

Wire method: session.mcp.reload.

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.

Source

pub async fn execute_sampling( &self, params: McpExecuteSamplingParams, ) -> Result<McpSamplingExecutionResult, Error>

Runs an MCP sampling inference on behalf of an MCP server.

Wire method: session.mcp.executeSampling.

§Parameters
  • params - Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.
§Returns

Outcome of an MCP sampling execution: success result, failure error, or cancellation.

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.

Source

pub async fn cancel_sampling_execution( &self, params: McpCancelSamplingExecutionParams, ) -> Result<McpCancelSamplingExecutionResult, Error>

Cancels an in-flight MCP sampling execution by request ID.

Wire method: session.mcp.cancelSamplingExecution.

§Parameters
  • params - The requestId previously passed to executeSampling that should be cancelled.
§Returns

Indicates whether an in-flight sampling execution with the given requestId was found and cancelled.

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.

Source

pub async fn set_env_value_mode( &self, params: McpSetEnvValueModeParams, ) -> Result<McpSetEnvValueModeResult, Error>

Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect).

Wire method: session.mcp.setEnvValueMode.

§Parameters
  • params - Mode controlling how MCP server env values are resolved (direct or indirect).
§Returns

Env-value mode recorded on the session after the update.

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.

Source

pub async fn remove_git_hub(&self) -> Result<McpRemoveGitHubResult, Error>

Removes the auto-managed github MCP server when present.

Wire method: session.mcp.removeGitHub.

§Returns

Indicates whether the auto-managed github MCP server was removed (false when nothing to remove).

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§

Source§

impl<'a> Clone for SessionRpcMcp<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SessionRpcMcp<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for SessionRpcMcp<'a>

§

impl<'a> !RefUnwindSafe for SessionRpcMcp<'a>

§

impl<'a> Send for SessionRpcMcp<'a>

§

impl<'a> Sync for SessionRpcMcp<'a>

§

impl<'a> Unpin for SessionRpcMcp<'a>

§

impl<'a> UnsafeUnpin for SessionRpcMcp<'a>

§

impl<'a> !UnwindSafe for SessionRpcMcp<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more