Skip to main content

McpClient

Struct McpClient 

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

MCP client with a background message loop.

Unlike previous versions, this type is not generic over the transport. The transport is consumed during connect() and moved into a background Tokio task that handles message multiplexing.

All public methods take &self, enabling concurrent use from multiple tasks.

§Construction

use tower_mcp::client::{McpClient, StdioClientTransport};

// Simple: no handler for server-initiated requests
let transport = StdioClientTransport::spawn("server", &[]).await?;
let client = McpClient::connect(transport).await?;

// With configuration
use tower_mcp::protocol::Root;
let transport = StdioClientTransport::spawn("server", &[]).await?;
let client = McpClient::builder()
    .with_roots(vec![Root::new("file:///project")])
    .connect_simple(transport)
    .await?;

Implementations§

Source§

impl McpClient

Source

pub async fn connect<T: ClientTransport>(transport: T) -> Result<Self>

Connect with default settings and no handler.

Shorthand for McpClient::builder().connect_simple(transport).

Source

pub async fn connect_with_handler<T, H>( transport: T, handler: H, ) -> Result<Self>

Connect with a handler for server-initiated requests.

Source

pub fn builder() -> McpClientBuilder

Create a builder for advanced configuration.

Source

pub fn is_initialized(&self) -> bool

Check if the client has been initialized.

Source

pub fn is_connected(&self) -> bool

Check if the transport is still connected.

Source

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

Get the server info (available after initialization).

Source

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

Initialize the MCP connection.

Sends the initialize request and notifications/initialized notification. Must be called before any other operations.

Source

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

List available tools.

Source

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

Call a tool.

Source

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

List available resources.

Source

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

Read a resource.

Source

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

List available prompts.

Source

pub async fn list_tools_with_cursor( &self, cursor: Option<String>, ) -> Result<ListToolsResult>

List tools with an optional pagination cursor.

Source

pub async fn list_resources_with_cursor( &self, cursor: Option<String>, ) -> Result<ListResourcesResult>

List resources with an optional pagination cursor.

Source

pub async fn list_resource_templates( &self, ) -> Result<ListResourceTemplatesResult>

List resource templates.

Source

pub async fn list_resource_templates_with_cursor( &self, cursor: Option<String>, ) -> Result<ListResourceTemplatesResult>

List resource templates with an optional pagination cursor.

Source

pub async fn list_prompts_with_cursor( &self, cursor: Option<String>, ) -> Result<ListPromptsResult>

List prompts with an optional pagination cursor.

Source

pub async fn list_all_tools(&self) -> Result<Vec<ToolDefinition>>

List all tools, following pagination cursors until exhausted.

Source

pub async fn list_all_resources(&self) -> Result<Vec<ResourceDefinition>>

List all resources, following pagination cursors until exhausted.

Source

pub async fn list_all_resource_templates( &self, ) -> Result<Vec<ResourceTemplateDefinition>>

List all resource templates, following pagination cursors until exhausted.

Source

pub async fn list_all_prompts(&self) -> Result<Vec<PromptDefinition>>

List all prompts, following pagination cursors until exhausted.

Source

pub async fn call_tool_text( &self, name: &str, arguments: Value, ) -> Result<String>

Call a tool and return the concatenated text content.

Returns the text from all Text items joined together. If the tool result indicates an error (is_error is true), returns an error with the text content as the message.

For more control over the result, use call_tool().

Source

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

Get a prompt.

Source

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

Ping the server.

Source

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

Request completion suggestions from the server.

Source

pub async fn complete_prompt_arg( &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( &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>( &self, method: &str, params: &P, ) -> Result<R>

Send a raw typed request to the server.

Source

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

Send a raw typed notification to the server.

Source

pub async fn roots(&self) -> Vec<Root>

Get the current roots.

Source

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

Set roots and notify the server if initialized.

Source

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

Add a root and notify the server if initialized.

Source

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

Remove a root by URI and notify the server if initialized.

Source

pub async fn list_roots(&self) -> ListRootsResult

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

Source

pub async fn shutdown(self) -> Result<()>

Gracefully shut down the client and close the transport.

Trait Implementations§

Source§

impl Drop for McpClient

Source§

fn drop(&mut self)

Executes the destructor for this type. 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> 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