mcp_core::server

Struct ServerProtocolBuilder

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

Builder for creating configured server protocols.

The ServerProtocolBuilder provides a fluent API for configuring and creating MCP server protocols with specific settings, tools, and capabilities.

Implementations§

Source§

impl ServerProtocolBuilder

Source

pub fn new(name: String, version: String) -> Self

Creates a new server protocol builder.

§Arguments
  • name - The server name
  • version - The server version
§Returns

A new ServerProtocolBuilder instance

Source

pub fn set_protocol_version(self, protocol_version: ProtocolVersion) -> Self

Sets the protocol version for the server.

§Arguments
  • protocol_version - The protocol version to use
§Returns

The modified builder instance

Source

pub fn set_capabilities(self, capabilities: ServerCapabilities) -> Self

Sets the server capabilities.

§Arguments
  • capabilities - The server capabilities
§Returns

The modified builder instance

Source

pub fn set_instructions(self, instructions: String) -> Self

Sets the server instructions.

Instructions provide guidance for AI models on how to use the server’s tools.

§Arguments
  • instructions - The instructions for using the server
§Returns

The modified builder instance

Source

pub fn remove_instructions(self) -> Self

Removes the server instructions.

§Returns

The modified builder instance

Source

pub fn register_tool(self, tool: Tool, f: ToolHandlerFn) -> Self

Registers a tool with the server.

§Arguments
  • tool - The tool definition
  • f - The handler function for the tool
§Returns

The modified builder instance

Source

pub fn get_client_capabilities(&self) -> Option<ClientCapabilities>

Gets the client capabilities, if available.

§Returns

An Option containing the client capabilities if available

Source

pub fn get_client_info(&self) -> Option<Implementation>

Gets the client information, if available.

§Returns

An Option containing the client information if available

Source

pub fn is_initialized(&self) -> bool

Checks if the client has completed initialization.

§Returns

true if the client is initialized, false otherwise

Source

pub fn build(self) -> Protocol

Builds the server protocol.

§Returns

A Protocol instance configured with the server’s settings

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

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

Source§

impl<T> MaybeSendSync for T