Skip to main content

RegistryServer

Struct RegistryServer 

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

MCP server handler backed by a ToolRegistry.

Features:

  • Automatic tool discovery from registry
  • Optional allowlist filtering
  • Configurable output mode (text or structured)

§Output Modes

  • Text (default): Returns human-readable text using TextFormat when available, falling back to pretty-printed JSON. Does not publish output_schema.
  • Structured: Publishes output_schema in list_tools and populates structured_content in call_tool responses (for MCP protocol compliance).

§Example

use agentic_tools_mcp::{RegistryServer, OutputMode};
use agentic_tools_core::ToolRegistry;
use std::sync::Arc;

let registry = Arc::new(ToolRegistry::builder()
    .register::<MyTool, ()>(MyTool)
    .finish());

// Text mode (default) - optimized for LLM consumption
let server = RegistryServer::new(registry.clone())
    .with_allowlist(["my_tool".to_string()]);

// Structured mode - MCP protocol compliance with typed responses
let server = RegistryServer::new(registry)
    .with_output_mode(OutputMode::Structured);

Implementations§

Source§

impl RegistryServer

Source

pub fn new(registry: Arc<ToolRegistry>) -> Self

Create a new server from a registry.

Source

pub fn with_allowlist(self, allowlist: impl IntoIterator<Item = String>) -> Self

Set an allowlist of tool names.

Only tools in this list will be visible and callable.

Source

pub fn with_output_mode(self, mode: OutputMode) -> Self

Set the output mode for tool results.

Source

pub fn with_text_options(self, text_options: TextOptions) -> Self

Set text formatting options for tool results.

Source

pub fn with_info(self, name: &str, version: &str) -> Self

Set the server name and version.

Source

pub fn name(&self) -> &str

Get the server name.

Source

pub fn version(&self) -> &str

Get the server version.

Source

pub fn output_mode(&self) -> OutputMode

Get the output mode.

Source

pub fn effective_tool_names(&self) -> Vec<String>

Get the list of effective tool names (respecting allowlist).

Trait Implementations§

Source§

impl ServerHandler for RegistryServer

Source§

fn initialize( &self, _params: InitializeRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<InitializeResult, ErrorData>> + Send + '_

Source§

fn list_tools( &self, _req: Option<PaginatedRequestParams>, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListToolsResult, ErrorData>> + Send + '_

Source§

fn call_tool( &self, req: CallToolRequestParams, request_context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<CallToolResult, ErrorData>> + Send + '_

Source§

fn ping( &self, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send + '_

Source§

fn complete( &self, _req: CompleteRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<CompleteResult, ErrorData>> + Send + '_

Source§

fn set_level( &self, _req: SetLevelRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send + '_

Source§

fn get_prompt( &self, _req: GetPromptRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<GetPromptResult, ErrorData>> + Send + '_

Source§

fn list_prompts( &self, _req: Option<PaginatedRequestParams>, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListPromptsResult, ErrorData>> + Send + '_

Source§

fn list_resources( &self, _req: Option<PaginatedRequestParams>, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListResourcesResult, ErrorData>> + Send + '_

Source§

fn list_resource_templates( &self, _req: Option<PaginatedRequestParams>, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListResourceTemplatesResult, ErrorData>> + Send + '_

Source§

fn read_resource( &self, _req: ReadResourceRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ReadResourceResult, ErrorData>> + Send + '_

Source§

fn subscribe( &self, _req: SubscribeRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send + '_

Source§

fn unsubscribe( &self, _req: UnsubscribeRequestParams, _ctx: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send + '_

Source§

fn enqueue_task( &self, _request: CallToolRequestParams, _context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<CreateTaskResult, ErrorData>> + MaybeSendFuture

Source§

fn get_tool(&self, _name: &str) -> Option<Tool>

Get a tool definition by name. Read more
Source§

fn on_custom_request( &self, request: CustomRequest, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<CustomResult, ErrorData>> + MaybeSendFuture

Source§

fn on_cancelled( &self, notification: CancelledNotificationParam, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + MaybeSendFuture

Source§

fn on_progress( &self, notification: ProgressNotificationParam, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + MaybeSendFuture

Source§

fn on_initialized( &self, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + MaybeSendFuture

Source§

fn on_roots_list_changed( &self, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + MaybeSendFuture

Source§

fn on_custom_notification( &self, notification: CustomNotification, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + MaybeSendFuture

Source§

fn get_info(&self) -> InitializeResult

Source§

fn list_tasks( &self, request: Option<PaginatedRequestParams>, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListTasksResult, ErrorData>> + MaybeSendFuture

Source§

fn get_task_info( &self, request: GetTaskInfoParams, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<GetTaskResult, ErrorData>> + MaybeSendFuture

Source§

fn get_task_result( &self, request: GetTaskResultParams, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<GetTaskPayloadResult, ErrorData>> + MaybeSendFuture

Source§

fn cancel_task( &self, request: CancelTaskParams, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<CancelTaskResult, ErrorData>> + MaybeSendFuture

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<R, S> DynService<R> for S
where R: ServiceRole, S: Service<R>,

Source§

fn handle_request( &self, request: <R as ServiceRole>::PeerReq, context: RequestContext<R>, ) -> Pin<Box<dyn Future<Output = Result<<R as ServiceRole>::Resp, ErrorData>> + Send + '_>>

Source§

fn handle_notification( &self, notification: <R as ServiceRole>::PeerNot, context: NotificationContext<R>, ) -> Pin<Box<dyn Future<Output = Result<(), ErrorData>> + Send + '_>>

Source§

fn get_info(&self) -> <R as ServiceRole>::Info

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<H> Service<RoleServer> for H
where H: ServerHandler,

Source§

impl<S> ServiceExt<RoleServer> for S
where S: Service<RoleServer>,

Source§

fn serve_with_ct<T, E, A>( self, transport: T, ct: CancellationToken, ) -> impl Future<Output = Result<RunningService<RoleServer, S>, ServerInitializeError>> + MaybeSendFuture
where T: IntoTransport<RoleServer, E, A>, E: Error + Send + Sync + 'static,

Source§

fn into_dyn(self) -> Box<dyn DynService<R>>

Convert this service to a dynamic boxed service Read more
Source§

fn serve<T, E, A>( self, transport: T, ) -> impl Future<Output = Result<RunningService<R, Self>, <R as ServiceRole>::InitializeError>> + MaybeSendFuture
where T: IntoTransport<R, E, A>, E: Error + Send + Sync + 'static, Self: Sized,

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