Skip to main content

McpServerBuilder

Struct McpServerBuilder 

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

Builder for McpServer — the main entry point for configuring your server.

Implementations§

Source§

impl McpServerBuilder

Source

pub fn new() -> Self

Source

pub fn name(self, name: impl Into<String>) -> Self

Set the server name (shown to clients during handshake)

Source

pub fn version(self, version: impl Into<String>) -> Self

Set the server version

Source

pub fn instructions(self, instructions: impl Into<String>) -> Self

Human-readable instructions for how to use this server

Source

pub fn auth(self, provider: DynAuthProvider) -> Self

Require authentication on all requests using the given provider.

Requests with no or invalid credentials receive HTTP 401 on SSE/HTTP transports. Stdio transport is unaffected (it relies on process-level access control).

§Example
use mcp_kit::prelude::*;
use mcp_kit::auth::BearerTokenProvider;
use std::sync::Arc;

McpServer::builder()
    .name("my-server")
    .version("1.0")
    .auth(Arc::new(BearerTokenProvider::new(["secret"])))
    .build();
Source

pub fn optional_auth(self, provider: DynAuthProvider) -> Self

Accept an auth provider but allow unauthenticated requests through.

Authenticated requests have an identity available via Auth; unauthenticated requests have no identity and may reach handlers with None.

Source

pub fn tool<M>(self, tool: Tool, handler: impl ToolHandler<M>) -> Self

Register a tool with an explicit Tool descriptor and a handler function.

Source

pub fn tool_def(self, def: ToolDef) -> Self

Register a tool using a pre-built ToolDef (from the #[tool] macro).

Source

pub fn tool_fn<M>( self, name: impl Into<String>, description: impl Into<String>, handler: impl ToolHandler<M>, ) -> Self

Convenience: register a no-parameter tool.

Source

pub fn resource<M>( self, resource: Resource, handler: impl ResourceHandler<M>, ) -> Self

Register a static resource (exact URI match).

Source

pub fn resource_template<M>( self, template: ResourceTemplate, handler: impl ResourceHandler<M>, ) -> Self

Register a URI-template resource (e.g. "file://{path}").

Source

pub fn resource_def(self, def: ResourceDef) -> Self

Register a resource using a pre-built ResourceDef (from the #[resource] macro).

Source

pub fn prompt<M>(self, prompt: Prompt, handler: impl PromptHandler<M>) -> Self

Register a prompt template.

Source

pub fn prompt_def(self, def: PromptDef) -> Self

Register a prompt using a pre-built PromptDef (from the #[prompt] macro).

Source

pub fn build(self) -> McpServer

Trait Implementations§

Source§

impl Default for McpServerBuilder

Source§

fn default() -> Self

Returns the “default value” for a 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> 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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,