mcp_host/
lib.rs

1//! mcp-host: Production-grade MCP server implementation
2//!
3//! This crate provides a comprehensive Model Context Protocol (MCP) server
4//! implementation with sophisticated features like circuit breakers, visibility
5//! predicates, session customization, and more.
6//!
7//! ## Features
8//!
9//! - `stdio` - STDIO transport (default)
10//! - `http` - HTTP transport via rama
11//! - `macros` - Procedural macros (#[mcp_tool], #[mcp_prompt], #[mcp_resource], etc.)
12//! - `full` - All features
13//!
14//! ## Quick Start
15//!
16//! ```rust,ignore
17//! use mcp_host::prelude::*;
18//! use mcp_host::macros::text;
19//! use schemars::JsonSchema;
20//! use serde::Deserialize;
21//!
22//! #[derive(Deserialize, JsonSchema)]
23//! struct GreetParams {
24//!     name: String,
25//! }
26//!
27//! struct MyServer;
28//!
29//! #[mcp_tool_router]
30//! impl MyServer {
31//!     #[mcp_tool(name = "greet")]
32//!     async fn greet(&self, _ctx: Ctx<'_>, params: Parameters<GreetParams>) -> ToolResult {
33//!         Ok(vec![text(&format!("Hello, {}!", params.0.name))])
34//!     }
35//! }
36//!
37//! #[tokio::main]
38//! async fn main() {
39//!     let server = mcp_host::server::builder::server("my-server", "1.0.0")
40//!         .with_tools(true)
41//!         .build();
42//!
43//!     let my_server = std::sync::Arc::new(MyServer);
44//!     MyServer::tool_router().register_all(server.tool_registry(), my_server);
45//!
46//!     server.run(StdioTransport::new()).await.unwrap();
47//! }
48//! ```
49//!
50//! Enable macros with: `mcp-host = { version = "0.1", features = ["macros"] }`
51
52pub mod content;
53pub mod logging;
54#[cfg(feature = "macros")]
55pub mod macros;
56pub mod managers;
57pub mod protocol;
58pub mod registry;
59pub mod server;
60pub mod transport;
61pub mod utils;
62
63// Re-export commonly used types
64pub mod prelude {
65    // Protocol types
66    pub use crate::protocol::capabilities::{ClientCapabilities, ServerCapabilities};
67    pub use crate::protocol::types::{
68        JsonRpcError, JsonRpcRequest, JsonRpcResponse, ToolAnnotations,
69    };
70
71    // Content types and builders
72    pub use crate::content::annotations::Annotations;
73    pub use crate::content::builder::{audio, image, resource, text};
74    pub use crate::content::resource::ResourceContent;
75    pub use crate::content::types::{
76        AudioContent, Content, ImageContent, ResourceLink, TextContent,
77    };
78
79    // Server types
80    pub use crate::server::builder::{ServerBuilder, server};
81    pub use crate::server::core::Server;
82    pub use crate::server::multiplexer::{
83        ClientRequester, CreateMessageParams, CreateMessageResult, JsonRpcClientRequest,
84        ListRootsResult, ModelHint, ModelPreferences, MultiplexerError, RequestMultiplexer, Root,
85        SamplingContent, SamplingMessage,
86    };
87    pub use crate::server::profile::SessionProfile;
88    pub use crate::server::session::Session;
89    pub use crate::server::visibility::{
90        Environment, ExecutionContext, SimpleEnvironment, VisibilityContext,
91    };
92
93    // Prompt message types
94    pub use crate::content::prompt::{PromptContent, PromptMessage, PromptRole};
95
96    // Completion types
97    pub use crate::protocol::types::{
98        CompleteRequest, CompleteResult, CompletionArgument, CompletionInfo, CompletionRef,
99        CompletionValue,
100    };
101
102    // Utility functions
103    pub use crate::utils::{
104        DEFAULT_PAGE_SIZE, PaginatedResult, base64_decode, base64_encode, byte_to_line_col,
105        collect_files, decode_cursor, encode_cursor, is_safe_path, paginate,
106    };
107
108    // Transport traits
109    pub use crate::transport::traits::{
110        IncomingMessage, JsonRpcNotification, Transport, TransportError, TransportFuture,
111    };
112
113    // Registry types
114    pub use crate::registry::prompts::{
115        GetPromptResult, Prompt, PromptArgument, PromptError, PromptFuture, PromptInfo,
116        PromptManager,
117    };
118    pub use crate::registry::resources::{
119        Resource, ResourceError, ResourceInfo, ResourceManager, ResourceReadFuture,
120        ResourceRetryConfig, ResourceTemplate, ResourceTemplateInfo,
121    };
122    pub use crate::registry::tools::{
123        Tool, ToolBreakerConfig, ToolError, ToolFuture, ToolHelpers, ToolInfo, ToolLifecycleState,
124        ToolOutput, ToolPolicy, ToolRegistry,
125    };
126
127    // Middleware
128    pub use crate::server::middleware::{RateLimiter, RateLimiterConfig};
129
130    // Logging
131    pub use crate::logging::{LogLevel, LoggerConfig, McpLogger, send_log_notification};
132
133    // Managers
134    pub use crate::managers::cancellation::{CancellationManager, CancellationToken};
135    pub use crate::managers::completion::{
136        CompletionError, CompletionFuture, CompletionManager, CompletionProvider,
137    };
138    pub use crate::managers::progress::{ProgressToken, ProgressTracker};
139    pub use crate::managers::subscription::SubscriptionManager;
140    pub use crate::managers::task::{TaskError, TaskStore};
141
142    // === Feature-gated exports ===
143
144    // STDIO transport
145    #[cfg(feature = "stdio")]
146    pub use crate::transport::stdio::StdioTransport;
147
148    // HTTP transport
149    #[cfg(feature = "http")]
150    pub use crate::transport::http::{HttpTransport, HttpTransportConfig, HttpTransportError};
151
152    // Routers and helpers (requires macros feature)
153    #[cfg(feature = "macros")]
154    pub use crate::registry::router::{
155        McpPromptRouter, McpResourceRouter, McpResourceTemplateRouter, McpRouter, McpToolRouter,
156        prompt_info, prompt_info_with_args, tool_info, tool_info_with_output,
157    };
158
159    // Macro support types (requires macros feature)
160    #[cfg(feature = "macros")]
161    pub use crate::macros::{
162        Ctx, FromExecutionContext, IntoToolResult, Parameters, PromptResult, ResourceResult,
163        ToolResult, assistant_image_message, assistant_message, blob_resource, prompt_messages,
164        prompt_with_description, schema_for, structured, text_resource, text_resource_with_mime,
165        user_image_message, user_message,
166    };
167
168    // Procedural macros (requires macros feature)
169    #[cfg(feature = "macros")]
170    pub use mcp_host_macros::{
171        mcp_prompt, mcp_resource, mcp_resource_template, mcp_router, mcp_tool,
172    };
173}
mcp_host/lib.rs

mcp_host/
lib.rs
