PooledClient

Struct PooledClient 

Source
pub struct PooledClient<T: Transport + 'static> { /* private fields */ }
Expand description

A pooled client connection.

When dropped, the connection is returned to the pool.

Implementations§

Source§

impl<T: Transport + 'static> PooledClient<T>

Source

pub fn client(&self) -> &Client<T>

Get a reference to the underlying client.

§Panics

Panics if the client was already dropped or taken. This should never happen in normal use - the panic indicates a bug in the pool implementation.

Source

pub fn client_mut(&mut self) -> &mut Client<T>

Get a mutable reference to the underlying client.

§Panics

Panics if the client was already dropped or taken. This should never happen in normal use - the panic indicates a bug in the pool implementation.

Methods from Deref<Target = Client<T>>§

Source

pub fn server_info(&self) -> &ServerInfo

Get the server information.

Source

pub fn server_capabilities(&self) -> &ServerCapabilities

Get the server capabilities.

Source

pub fn protocol_version(&self) -> ProtocolVersion

Get the negotiated protocol version.

Use this for feature detection. For example:

if client.protocol_version().supports_tasks() {
    // Use task-related features
}
Source

pub fn client_info(&self) -> &ClientInfo

Get the client information.

Source

pub fn client_capabilities(&self) -> &ClientCapabilities

Get the client capabilities.

Source

pub fn instructions(&self) -> Option<&str>

Get the server instructions, if provided.

Source

pub fn has_tools(&self) -> bool

Check if the server supports tools.

Source

pub fn has_resources(&self) -> bool

Check if the server supports resources.

Source

pub fn has_prompts(&self) -> bool

Check if the server supports prompts.

Source

pub fn has_tasks(&self) -> bool

Check if the server supports tasks.

Source

pub fn has_completions(&self) -> bool

Check if the server supports completions.

Source

pub fn is_connected(&self) -> bool

Check if the client is still connected.

Source

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

List all available tools.

§Errors

Returns an error if tools are not supported or the request fails.

Source

pub async fn list_tools_paginated( &self, cursor: Option<&str>, ) -> Result<ListToolsResult, McpError>

List tools with pagination.

§Errors

Returns an error if tools are not supported or the request fails.

Source

pub async fn call_tool( &self, name: impl Into<String>, arguments: Value, ) -> Result<CallToolResult, McpError>

Call a tool by name.

§Arguments
  • name - The name of the tool to call
  • arguments - The arguments to pass to the tool (as JSON)
§Errors

Returns an error if tools are not supported or the call fails.

Source

pub async fn list_resources(&self) -> Result<Vec<Resource>, McpError>

List all available resources.

§Errors

Returns an error if resources are not supported or the request fails.

Source

pub async fn list_resources_paginated( &self, cursor: Option<&str>, ) -> Result<ListResourcesResult, McpError>

List resources with pagination.

§Errors

Returns an error if resources are not supported or the request fails.

Source

pub async fn list_resource_templates( &self, ) -> Result<Vec<ResourceTemplate>, McpError>

List resource templates.

§Errors

Returns an error if resources are not supported or the request fails.

Source

pub async fn read_resource( &self, uri: impl Into<String>, ) -> Result<Vec<ResourceContents>, McpError>

Read a resource by URI.

§Errors

Returns an error if resources are not supported or the read fails.

Source

pub async fn list_prompts(&self) -> Result<Vec<Prompt>, McpError>

List all available prompts.

§Errors

Returns an error if prompts are not supported or the request fails.

Source

pub async fn list_prompts_paginated( &self, cursor: Option<&str>, ) -> Result<ListPromptsResult, McpError>

List prompts with pagination.

§Errors

Returns an error if prompts are not supported or the request fails.

Source

pub async fn get_prompt( &self, name: impl Into<String>, arguments: Option<Map<String, Value>>, ) -> Result<GetPromptResult, McpError>

Get a prompt by name, optionally with arguments.

§Errors

Returns an error if prompts are not supported or the get fails.

Source

pub async fn list_tasks(&self) -> Result<Vec<TaskSummary>, McpError>

List all tasks.

§Errors

Returns an error if tasks are not supported or the request fails.

Source

pub async fn list_tasks_filtered( &self, status: Option<TaskStatus>, cursor: Option<&str>, ) -> Result<ListTasksResult, McpError>

List tasks with optional status filter and pagination.

§Errors

Returns an error if tasks are not supported or the request fails.

Source

pub async fn get_task(&self, id: impl Into<String>) -> Result<Task, McpError>

Get a task by ID.

§Errors

Returns an error if tasks are not supported or the task is not found.

Source

pub async fn cancel_task(&self, id: impl Into<String>) -> Result<(), McpError>

Cancel a running task.

§Errors

Returns an error if tasks are not supported, cancellation is not supported, or the task is not found.

Source

pub async fn complete_prompt_argument( &self, prompt_name: impl Into<String>, argument_name: impl Into<String>, current_value: impl Into<String>, ) -> Result<CompleteResult, McpError>

Get completions for a prompt argument.

§Arguments
  • prompt_name - The name of the prompt
  • argument_name - The name of the argument to complete
  • current_value - The current partial value being typed
§Errors

Returns an error if completions are not supported or the request fails.

Source

pub async fn complete_resource_argument( &self, resource_uri: impl Into<String>, argument_name: impl Into<String>, current_value: impl Into<String>, ) -> Result<CompleteResult, McpError>

Get completions for a resource argument.

§Arguments
  • resource_uri - The URI of the resource
  • argument_name - The name of the argument to complete
  • current_value - The current partial value being typed
§Errors

Returns an error if completions are not supported or the request fails.

Source

pub async fn subscribe_resource( &self, uri: impl Into<String>, ) -> Result<(), McpError>

Subscribe to updates for a resource.

When subscribed, the server will send notifications/resources/updated when the resource changes.

§Errors

Returns an error if resource subscriptions are not supported or the request fails.

Source

pub async fn unsubscribe_resource( &self, uri: impl Into<String>, ) -> Result<(), McpError>

Unsubscribe from updates for a resource.

§Errors

Returns an error if resource subscriptions are not supported or the request fails.

Source

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

Ping the server.

§Errors

Returns an error if the ping fails.

Trait Implementations§

Source§

impl<T: Transport + 'static> Deref for PooledClient<T>

Source§

type Target = Client<T>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T: Transport + 'static> DerefMut for PooledClient<T>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<T: Transport + 'static> Drop for PooledClient<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for PooledClient<T>

§

impl<T> !RefUnwindSafe for PooledClient<T>

§

impl<T> Send for PooledClient<T>

§

impl<T> Sync for PooledClient<T>

§

impl<T> Unpin for PooledClient<T>

§

impl<T> !UnwindSafe for PooledClient<T>

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<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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