Skip to main content

McpClient

Struct McpClient 

Source
pub struct McpClient { /* private fields */ }
Expand description

A connected client. Cheap to clone, and clones share the connection.

Implementations§

Source§

impl McpClient

Source

pub async fn connect( options: ClientOptions, transport: Transport, ) -> Result<McpClient, McpError>

Opens transport and performs the initialize handshake.

Source

pub async fn connect_with_stderr( options: ClientOptions, transport: Transport, ) -> Result<McpClient, Box<(McpError, Option<String>)>>

McpClient::connect, failing with a stdio server’s stderr too, as pi reads it for every failed connection.

Source

pub fn same(&self, other: &McpClient) -> bool

Whether other is a clone of this client.

Source

pub fn is_connected(&self) -> bool

Whether the connection is open.

Source

pub fn server(&self) -> Option<ServerInfo>

What the server said in initialize.

Source

pub fn stderr(&self) -> Option<String>

The end of a stdio server’s stderr.

Source

pub fn on_notification( &self, method: &str, listener: impl Fn(&Value) + Send + Sync + 'static, )

Calls listener with the parameters of every method notification.

Source

pub fn on_close(&self, listener: impl Fn() + Send + Sync + 'static)

Calls listener once when the connection closes, for any reason.

Source

pub async fn request( &self, method: &str, params: Option<Value>, options: RequestOptions, ) -> Result<Value, McpError>

Sends a request and waits for its result.

Source

pub async fn list_tools( &self, options: RequestOptions, ) -> Result<Vec<Tool>, McpError>

Every tool, following pagination.

Source

pub async fn list_resources( &self, kind: ResourceKind, options: RequestOptions, ) -> Result<Vec<Value>, McpError>

Every resource or resource template, following pagination.

Source

pub async fn list_resources_page( &self, kind: ResourceKind, cursor: Option<String>, options: RequestOptions, ) -> Result<(Vec<Value>, Option<String>), McpError>

One page of resources or resource templates from cursor, and the next cursor.

Source

pub async fn read_resource( &self, uri: &str, options: RequestOptions, ) -> Result<Value, McpError>

Reads one resource.

Source

pub async fn call_tool( &self, name: &str, arguments: Value, options: RequestOptions, ) -> Result<Value, McpError>

Calls a tool. A result without content gets an empty one, as the SDKs default it.

Source

pub async fn close(&self)

Closes the connection. Requests in flight fail.

Trait Implementations§

Source§

impl Clone for McpClient

Source§

fn clone(&self) -> Self

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

Auto Trait Implementations§

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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