pulseengine_mcp_protocol/lib.rs
1//! Core Model Context Protocol types and validation
2//!
3//! This crate provides the fundamental types, traits, and validation logic
4//! for the Model Context Protocol. It serves as the foundation for building
5//! MCP servers and clients with strong type safety and validation.
6//!
7//! # Quick Start
8//!
9//! ```rust
10//! use pulseengine_mcp_protocol::{Tool, Content, CallToolResult};
11//! use serde_json::json;
12//!
13//! // Define a tool with proper schema and optional output schema
14//! let tool = Tool {
15//! name: "get_weather".to_string(),
16//! description: "Get current weather for a location".to_string(),
17//! input_schema: json!({
18//! "type": "object",
19//! "properties": {
20//! "location": {
21//! "type": "string",
22//! "description": "City name or coordinates"
23//! }
24//! },
25//! "required": ["location"]
26//! }),
27//! output_schema: Some(json!({
28//! "type": "object",
29//! "properties": {
30//! "temperature": {"type": "string"},
31//! "condition": {"type": "string"}
32//! }
33//! })),
34//! };
35//!
36//! // Create a tool response with optional structured content
37//! let result = CallToolResult {
38//! content: vec![Content::text("Current weather: 22°C, sunny".to_string())],
39//! is_error: Some(false),
40//! structured_content: Some(json!({
41//! "temperature": "22°C",
42//! "condition": "sunny"
43//! })),
44//! };
45//! ```
46//!
47//! This crate is currently used in production by the Loxone MCP Server
48//! for home automation with 30+ tools.
49
50pub mod error;
51pub mod errors;
52pub mod model;
53pub mod validation;
54
55#[cfg(test)]
56mod error_tests;
57#[cfg(test)]
58mod lib_tests;
59#[cfg(test)]
60mod model_tests;
61#[cfg(test)]
62mod validation_tests;
63
64// Re-export core types for easy access
65pub use error::{Error, ErrorCode, McpResult, Result};
66pub use errors::{CommonError, CommonResult};
67pub use model::*;
68pub use validation::Validator;
69
70/// Protocol version constants
71pub const MCP_VERSION: &str = "2025-06-18";
72pub const SUPPORTED_PROTOCOL_VERSIONS: &[&str] = &["2025-06-18", "2025-03-26", "2024-11-05"];
73
74/// Check if a protocol version is supported
75pub fn is_protocol_version_supported(version: &str) -> bool {
76 SUPPORTED_PROTOCOL_VERSIONS.contains(&version)
77}
78
79/// Validate MCP protocol version compatibility
80///
81/// # Errors
82///
83/// Returns an error if the client version is not supported by this server
84pub fn validate_protocol_version(client_version: &str) -> Result<()> {
85 if is_protocol_version_supported(client_version) {
86 Ok(())
87 } else {
88 Err(Error::protocol_version_mismatch(
89 client_version,
90 MCP_VERSION,
91 ))
92 }
93}