Skip to main content

CratesDocsHandler

Struct CratesDocsHandler 

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

MCP server handler

Implements standard MCP protocol handler interface, handles client requests.

§Fields

  • server: Server instance
  • config: Handler configuration
  • metrics: Optional metrics collector

Implementations§

Source§

impl CratesDocsHandler

Source

pub fn new(server: Arc<CratesDocsServer>) -> Self

Create new handler

§Arguments
  • server - Server instance
§Example
use std::sync::Arc;
use crates_docs::server::{CratesDocsServer, CratesDocsHandler};
use crates_docs::AppConfig;

let config = AppConfig::default();
let server = Arc::new(CratesDocsServer::new(config).unwrap());
let handler = CratesDocsHandler::new(server);
Source

pub fn with_config(server: Arc<CratesDocsServer>, config: HandlerConfig) -> Self

Create handler with configuration

Source

pub fn with_merged_config( server: Arc<CratesDocsServer>, base_config: HandlerConfig, override_config: Option<HandlerConfig>, ) -> Self

Create handler with merged configuration

Source

pub fn with_metrics(self, metrics: Arc<ServerMetrics>) -> Self

Set metrics

Source

pub fn server(&self) -> &Arc<CratesDocsServer>

Get server reference

Source

pub fn tool_registry(&self) -> &ToolRegistry

Get tool registry

Source

pub fn config(&self) -> &HandlerConfig

Get configuration

Source

pub fn metrics(&self) -> Option<&Arc<ServerMetrics>>

Get metrics (optional)

Source

pub fn list_tools(&self) -> ListToolsResult

Get all tools list

Source

pub fn list_resources(&self) -> ListResourcesResult

Get empty resources list

Source

pub fn list_prompts(&self) -> ListPromptsResult

Get empty prompts list

Source

pub async fn execute_tool( &self, params: CallToolRequestParams, ) -> ToolExecutionResult

Execute tool call (core logic)

This method encapsulates the complete tool execution flow:

  • tracing tracking
  • timing statistics
  • metrics recording (if enabled)
§Returns

Returns ToolExecutionResult, can be converted to different types to adapt to different traits

Trait Implementations§

Source§

impl ServerHandler for CratesDocsHandler

Source§

fn handle_list_tools_request<'life0, 'async_trait>( &'life0 self, _request: Option<PaginatedRequestParams>, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<ListToolsResult, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle list tools request

Source§

fn handle_call_tool_request<'life0, 'async_trait>( &'life0 self, params: CallToolRequestParams, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<CallToolResult, CallToolError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle call tool request

Source§

fn handle_list_resources_request<'life0, 'async_trait>( &'life0 self, _request: Option<PaginatedRequestParams>, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<ListResourcesResult, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle list resources request

Source§

fn handle_read_resource_request<'life0, 'async_trait>( &'life0 self, _params: ReadResourceRequestParams, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<ReadResourceResult, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle read resource request

Source§

fn handle_list_prompts_request<'life0, 'async_trait>( &'life0 self, _request: Option<PaginatedRequestParams>, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<ListPromptsResult, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle list prompts request

Source§

fn handle_get_prompt_request<'life0, 'async_trait>( &'life0 self, _params: GetPromptRequestParams, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<GetPromptResult, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle get prompt request

Source§

fn on_initialized<'life0, 'async_trait>( &'life0 self, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Invoked when the server finishes initialization and receives an initialized_notification from the client. Read more
Source§

fn handle_initialize_request<'life0, 'async_trait>( &'life0 self, params: InitializeRequestParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<InitializeResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles the InitializeRequest from a client. Read more
Source§

fn handle_ping_request<'life0, 'async_trait>( &'life0 self, _params: Option<RequestParams>, _runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<Result, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles ping requests from clients. Read more
Source§

fn handle_list_resource_templates_request<'life0, 'async_trait>( &'life0 self, params: Option<PaginatedRequestParams>, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<ListResourceTemplatesResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles requests to list resource templates. Read more
Source§

fn handle_subscribe_request<'life0, 'async_trait>( &'life0 self, params: SubscribeRequestParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<Result, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles subscription requests from clients. Read more
Source§

fn handle_unsubscribe_request<'life0, 'async_trait>( &'life0 self, params: UnsubscribeRequestParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<Result, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles unsubscribe requests from clients. Read more
Source§

fn handle_task_augmented_tool_call<'life0, 'async_trait>( &'life0 self, params: CallToolRequestParams, task_creator: TaskCreator<ClientJsonrpcRequest, ResultFromServer>, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<CreateTaskResult, CallToolError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles requests to call a task-augmented tool. you need to returns a CreateTaskResult containing task data. The actual operation result becomes available later through tasks/result after the task completes.
Source§

fn handle_set_level_request<'life0, 'async_trait>( &'life0 self, params: SetLevelRequestParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<Result, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles requests to enable or adjust logging level. Read more
Source§

fn handle_complete_request<'life0, 'async_trait>( &'life0 self, params: CompleteRequestParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<CompleteResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles completion requests from clients. Read more
Source§

fn handle_get_task_request<'life0, 'async_trait>( &'life0 self, params: GetTaskParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<GetTaskResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles a request to retrieve the state of a task.
Source§

fn handle_get_task_payload_request<'life0, 'async_trait>( &'life0 self, params: GetTaskPayloadParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<GetTaskPayloadResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles a request to retrieve the result of a completed task.
Source§

fn handle_cancel_task_request<'life0, 'async_trait>( &'life0 self, params: CancelTaskParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<CancelTaskResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles a request to cancel a task.
Source§

fn handle_list_task_request<'life0, 'async_trait>( &'life0 self, params: Option<PaginatedRequestParams>, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<ListTasksResult, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles a request to retrieve a list of tasks.
Source§

fn handle_custom_request<'life0, 'async_trait>( &'life0 self, request: CustomRequest, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<Result, RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles custom requests not defined in the standard protocol. Read more
Source§

fn handle_initialized_notification<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles initialized notifications from clients. Customize this function in your specific handler to implement behavior tailored to your MCP server’s capabilities and requirements.
Source§

fn handle_cancelled_notification<'life0, 'async_trait>( &'life0 self, params: CancelledNotificationParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles cancelled operation notifications. Customize this function in your specific handler to implement behavior tailored to your MCP server’s capabilities and requirements.
Source§

fn handle_progress_notification<'life0, 'async_trait>( &'life0 self, params: ProgressNotificationParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles progress update notifications. Customize this function in your specific handler to implement behavior tailored to your MCP server’s capabilities and requirements.
Source§

fn handle_roots_list_changed_notification<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles notifications received from the client indicating that the list of roots has changed Customize this function in your specific handler to implement behavior tailored to your MCP server’s capabilities and requirements.
Source§

fn handle_task_status_notification<'life0, 'async_trait>( &'life0 self, params: TaskStatusNotificationParams, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

handles a notification from the receiver to the requestor, informing them that a task’s status has changed.
Source§

fn handle_custom_notification<'life0, 'async_trait>( &'life0 self, notification: CustomRequest, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Handles custom notifications not defined in the standard protocol. Customize this function in your specific handler to implement behavior tailored to your MCP server’s capabilities and requirements.
Source§

fn handle_error<'life0, 'life1, 'async_trait>( &'life0 self, error: &'life1 RpcError, runtime: Arc<dyn McpServer>, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Handles server errors that occur during operation. 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> ToMcpServerHandler for T
where T: ServerHandler + 'static,

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