mcpkit-server 0.7.0

Server implementation for mcpkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! Server implementation for the MCP SDK.
//!
//! This crate provides the server-side implementation for the Model Context
//! Protocol. It includes composable handler traits, a fluent builder API,
//! and request routing.
//!
//! # Overview
//!
//! Building an MCP server involves:
//!
//! 1. Implementing the [`ServerHandler`] trait (required)
//! 2. Implementing optional capability traits ([`ToolHandler`], [`ResourceHandler`], etc.)
//! 3. Using [`ServerBuilder`] to create a configured server
//! 4. Running the server with a transport
//!
//! # Example
//!
//! ```rust
//! use mcpkit_server::{ServerBuilder, ServerHandler};
//! use mcpkit_core::capability::{ServerInfo, ServerCapabilities};
//!
//! struct MyServer;
//!
//! impl ServerHandler for MyServer {
//!     fn server_info(&self) -> ServerInfo {
//!         ServerInfo::new("my-server", "1.0.0")
//!     }
//!
//!     fn capabilities(&self) -> ServerCapabilities {
//!         ServerCapabilities::new().with_tools()
//!     }
//! }
//!
//! let server = ServerBuilder::new(MyServer).build();
//! assert!(server.capabilities().has_tools());
//! ```
//!
//! # Handler Traits
//!
//! The server uses composable handler traits:
//!
//! - [`ServerHandler`]: Core trait required for all servers
//! - [`ToolHandler`]: Handle tool discovery and execution
//! - [`ResourceHandler`]: Handle resource discovery and reading
//! - [`PromptHandler`]: Handle prompt discovery and rendering
//! - [`TaskHandler`]: Handle long-running task operations
//!
//! # Context
//!
//! Handlers receive a [`Context`] that provides:
//!
//! - Request metadata (ID, progress token)
//! - Client and server capabilities
//! - Cancellation checking
//! - Progress reporting
//! - Notification sending

#![deny(missing_docs)]

pub mod adapter_peer;
pub mod builder;
pub mod capability;
pub mod context;
pub mod dispatch;
pub mod handler;
pub mod health;
pub mod metrics;
pub mod router;
pub mod server;
pub mod state;
#[cfg(feature = "tokio")]
pub mod streams;
#[cfg(feature = "schema-validation")]
pub mod validation;

// Re-export commonly used types
pub use builder::{FullServer, MinimalServer, NotRegistered, Registered, Server, ServerBuilder};
pub use context::{CancellationToken, CancelledFuture, Context, ContextData, NoOpPeer, Peer};
pub use handler::{
    CompletionHandler, LogLevel, PromptHandler, ResourceHandler, ServerHandler, TaskHandler,
    ToolHandler,
};
pub use health::{
    ComponentHealth, HealthChecker, HealthReport, HealthStatus, LivenessResponse, ReadinessResponse,
};
pub use metrics::{MethodStats, MetricsSnapshot, ServerMetrics};
pub use router::{
    AugmentedTaskOutcome, begin_augmented_task, call_tool_json, dispatch_notification_hooks,
    route_completion, route_logging, route_prompts, route_resources, route_tools,
    run_augmented_tool, tool_task_support,
};
pub use server::{
    RequestRouter, RuntimeConfig, ServerNotifier, ServerRuntime, ServerState, TransportPeer,
};
#[cfg(feature = "schema-validation")]
pub use validation::{ValidatingToolHandler, ValidationMode, validate_json};

/// Prelude module for convenient imports.
pub mod prelude {
    pub use crate::builder::{
        FullServer, MinimalServer, NotRegistered, Registered, Server, ServerBuilder,
    };
    pub use crate::context::{
        CancellationToken, CancelledFuture, Context, ContextData, NoOpPeer, Peer,
    };
    pub use crate::handler::{
        CompletionHandler, LogLevel, PromptHandler, ResourceHandler, ServerHandler, TaskHandler,
        ToolHandler,
    };
    pub use crate::metrics::{MethodStats, MetricsSnapshot, ServerMetrics};
}