Skip to main content

McpClient

Struct McpClient 

Source
pub struct McpClient<T: ClientTransport> { /* private fields */ }
Expand description

MCP Client for connecting to MCP servers

Implementations§

Source§

impl<T: ClientTransport> McpClient<T>

Source

pub fn new(transport: T) -> Self

Create a new MCP client with the given transport

Source

pub fn with_roots(transport: T, roots: Vec<Root>) -> Self

Create a new MCP client with roots capability

The client will declare roots support during initialization.

Source

pub fn with_capabilities(transport: T, capabilities: ClientCapabilities) -> Self

Create a new MCP client with custom capabilities

Source

pub fn server_info(&self) -> Option<&InitializeResult>

Get the server info (available after initialization)

Source

pub fn is_initialized(&self) -> bool

Check if the client is initialized

Source

pub fn roots(&self) -> &[Root]

Get the current roots

Source

pub async fn set_roots(&mut self, roots: Vec<Root>) -> Result<()>

Set roots and notify the server if initialized

If the client is already initialized, sends a roots list changed notification.

Source

pub async fn add_root(&mut self, root: Root) -> Result<()>

Add a root and notify the server if initialized

Source

pub async fn remove_root(&mut self, uri: &str) -> Result<bool>

Remove a root by URI and notify the server if initialized

Source

pub fn list_roots(&self) -> ListRootsResult

Get the roots list result (for responding to server’s roots/list request)

Returns a result suitable for responding to a roots/list request from the server.

Source

pub async fn initialize( &mut self, client_name: &str, client_version: &str, ) -> Result<&InitializeResult>

Initialize the MCP connection

Source

pub async fn list_tools(&mut self) -> Result<ListToolsResult>

List available tools

Source

pub async fn call_tool( &mut self, name: &str, arguments: Value, ) -> Result<CallToolResult>

Call a tool

Source

pub async fn list_resources(&mut self) -> Result<ListResourcesResult>

List available resources

Source

pub async fn read_resource(&mut self, uri: &str) -> Result<ReadResourceResult>

Read a resource

Source

pub async fn list_prompts(&mut self) -> Result<ListPromptsResult>

List available prompts

Source

pub async fn get_prompt( &mut self, name: &str, arguments: Option<HashMap<String, String>>, ) -> Result<GetPromptResult>

Get a prompt

Source

pub async fn ping(&mut self) -> Result<()>

Ping the server

Source

pub async fn complete( &mut self, reference: CompletionReference, argument_name: &str, argument_value: &str, ) -> Result<CompleteResult>

Request completion suggestions from the server

This is used to get autocomplete suggestions for prompt arguments or resource URIs.

Source

pub async fn complete_prompt_arg( &mut self, prompt_name: &str, argument_name: &str, argument_value: &str, ) -> Result<CompleteResult>

Request completion for a prompt argument

Source

pub async fn complete_resource_uri( &mut self, resource_uri: &str, argument_name: &str, argument_value: &str, ) -> Result<CompleteResult>

Request completion for a resource URI

Source

pub async fn request<P: Serialize, R: DeserializeOwned>( &mut self, method: &str, params: &P, ) -> Result<R>

Send a raw request

Source

pub async fn notify<P: Serialize>( &mut self, method: &str, params: &P, ) -> Result<()>

Send a notification

Auto Trait Implementations§

§

impl<T> Freeze for McpClient<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for McpClient<T>
where T: RefUnwindSafe,

§

impl<T> Send for McpClient<T>

§

impl<T> Sync for McpClient<T>
where T: Sync,

§

impl<T> Unpin for McpClient<T>
where T: Unpin,

§

impl<T> UnwindSafe for McpClient<T>
where T: UnwindSafe,

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> 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, 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