Struct McpClient

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

MCP client

MCP server’s methods to call and respond to client feature requests from the server.

To create an McpClient, use the with_server method or McpClientBuilder. The method to create an McpClient performs an initialize request to the server and returns control when the request completes.

§Example

use mcp_attr::client::McpClient;
use mcp_attr::schema::{ListPromptsRequestParams, ListResourcesRequestParams, CallToolRequestParams};
use mcp_attr::server::{McpServer, mcp_server};

struct MyServer;

#[mcp_server]
impl McpServer for MyServer {}

let server = MyServer;
let client = McpClient::with_server(server).await?;

// Get prompt list
let prompts = client.prompts_list(None).await?;

// Get resource list
let resources = client.resources_list(None).await?;

// Call tool
let params = CallToolRequestParams {
    name: "tool_name".to_string(),
    arguments: Some(serde_json::Map::new()),
};
let result = client.tools_call(params).await?;

Implementations§

Source§

impl McpClient

Source

pub async fn with_server(server: impl McpServer) -> SessionResult<Self>

Connects to the specified McpServer in-process

Performs an initialize request to the server and returns the result

Source

pub async fn initialize( session: Session, p: InitializeRequestParams, ) -> SessionResult<Self>

Connects to an MCP server using the specified JSON RPC Session

This Session uses the values returned from McpClientBuilder::build_raw.

Performs an initialize request to the server and returns the result

Source

pub fn session(&self) -> &Session

Gets the JSON RPC Session

Source

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

Gets the instructions obtained from the initialize request response

Source

pub fn server_info(&self) -> &Implementation

Gets the server_info obtained from the initialize request response

Source

pub async fn prompts_list( &self, params: Option<ListPromptsRequestParams>, ) -> SessionResult<ListPromptsResult>

Source

pub async fn prompts_get( &self, params: GetPromptRequestParams, ) -> SessionResult<GetPromptResult>

Source

pub async fn resources_list( &self, params: Option<ListResourcesRequestParams>, ) -> SessionResult<ListResourcesResult>

Source

pub async fn resources_templates_list( &self, params: Option<ListResourceTemplatesRequestParams>, ) -> SessionResult<ListResourceTemplatesResult>

Source

pub async fn resources_read( &self, params: ReadResourceRequestParams, ) -> SessionResult<ReadResourceResult>

Source

pub async fn tools_list( &self, params: Option<ListToolsRequestParams>, ) -> SessionResult<ListToolsResult>

Calls tools/list

Source

pub async fn tools_call( &self, params: CallToolRequestParams, ) -> SessionResult<CallToolResult>

Calls tools/call

Source

pub async fn completion_complete( &self, params: CompleteRequestParams, ) -> SessionResult<CompleteResult>

Source

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

Calls ping

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> IntoResult<T> for T

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T