ServerCoreBuilder

Struct ServerCoreBuilder 

Source
pub struct ServerCoreBuilder { /* private fields */ }
Available on non-WebAssembly only.
Expand description

Builder for constructing a ServerCore instance.

This builder provides a fluent API for configuring all aspects of the server before creating the final ServerCore instance.

§Examples

use pmcp::server::builder::ServerCoreBuilder;
use pmcp::server::core::ServerCore;
use pmcp::{ToolHandler, ServerCapabilities};
use async_trait::async_trait;
use serde_json::Value;

struct MyTool;

#[async_trait]
impl ToolHandler for MyTool {
    async fn handle(&self, args: Value, _extra: pmcp::RequestHandlerExtra) -> pmcp::Result<Value> {
        Ok(serde_json::json!({"result": "success"}))
    }
}

let server = ServerCoreBuilder::new()
    .name("my-server")
    .version("1.0.0")
    .tool("my-tool", MyTool)
    .capabilities(ServerCapabilities::tools_only())
    .build()?;

Implementations§

Source§

impl ServerCoreBuilder

Source

pub fn new() -> Self

Create a new builder with default settings.

Source

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

Set the server name.

This is a required field that identifies the server implementation.

Source

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

Set the server version.

This is a required field that identifies the server version.

Source

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

Set the server capabilities.

Defines what features this server supports.

Source

pub fn tool( self, name: impl Into<String>, handler: impl ToolHandler + 'static, ) -> Self

Add a tool handler.

Tools are functions that can be called by the client.

Source

pub fn tool_arc( self, name: impl Into<String>, handler: Arc<dyn ToolHandler>, ) -> Self

Add a tool handler with an Arc.

This variant is useful when you need to share the handler across multiple servers.

Source

pub fn prompt( self, name: impl Into<String>, handler: impl PromptHandler + 'static, ) -> Self

Add a prompt handler.

Prompts are templates that generate messages for the client.

Source

pub fn prompt_arc( self, name: impl Into<String>, handler: Arc<dyn PromptHandler>, ) -> Self

Add a prompt handler with an Arc.

This variant is useful when you need to share the handler across multiple servers.

Source

pub fn resources(self, handler: impl ResourceHandler + 'static) -> Self

Set the resource handler.

Resources provide access to data that the client can read.

Source

pub fn resources_arc(self, handler: Arc<dyn ResourceHandler>) -> Self

Set the resource handler with an Arc.

This variant is useful when you need to share the handler across multiple servers.

Source

pub fn sampling(self, handler: impl SamplingHandler + 'static) -> Self

Set the sampling handler.

Sampling provides LLM capabilities for message generation.

Source

pub fn sampling_arc(self, handler: Arc<dyn SamplingHandler>) -> Self

Set the sampling handler with an Arc.

This variant is useful when you need to share the handler across multiple servers.

Source

pub fn auth_provider(self, provider: impl AuthProvider + 'static) -> Self

Set the authentication provider.

The auth provider validates client authentication.

Source

pub fn auth_provider_arc(self, provider: Arc<dyn AuthProvider>) -> Self

Set the authentication provider with an Arc.

This variant is useful when you need to share the provider across multiple servers.

Source

pub fn tool_authorizer(self, authorizer: impl ToolAuthorizer + 'static) -> Self

Set the tool authorizer.

The tool authorizer provides fine-grained access control for tools.

Source

pub fn tool_authorizer_arc(self, authorizer: Arc<dyn ToolAuthorizer>) -> Self

Set the tool authorizer with an Arc.

This variant is useful when you need to share the authorizer across multiple servers.

Source

pub fn build(self) -> Result<ServerCore>

Build the ServerCore instance.

Returns an error if required fields (name, version) are not set.

Trait Implementations§

Source§

impl Default for ServerCoreBuilder

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<T> ErasedDestructor for T
where T: 'static,