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//! title: None,
35//! annotations: None,
36//! icons: None,
37//! };
38//!
39//! // Create a tool response with optional structured content
40//! let result = CallToolResult {
41//! content: vec![Content::text("Current weather: 22°C, sunny".to_string())],
42//! is_error: Some(false),
43//! structured_content: Some(json!({
44//! "temperature": "22°C",
45//! "condition": "sunny"
46//! })),
47//! _meta: None,
48//! };
49//! ```
50//!
51//! This crate is currently used in production by the Loxone MCP Server
52//! for home automation with 30+ tools.
53
54pub mod error;
55pub mod errors;
56pub mod model;
57pub mod validation;
58
59#[cfg(test)]
60mod error_tests;
61#[cfg(test)]
62mod lib_tests;
63#[cfg(test)]
64mod model_tests;
65#[cfg(test)]
66mod validation_tests;
67
68// Re-export core types for easy access
69pub use error::{Error, ErrorCode, McpResult, Result};
70pub use errors::{CommonError, CommonResult};
71pub use model::*;
72pub use validation::Validator;
73
74/// Protocol version constants
75pub const MCP_VERSION: &str = "2025-06-18";
76pub const SUPPORTED_PROTOCOL_VERSIONS: &[&str] = &["2025-06-18", "2025-03-26", "2024-11-05"];
77
78/// Check if a protocol version is supported
79pub fn is_protocol_version_supported(version: &str) -> bool {
80 SUPPORTED_PROTOCOL_VERSIONS.contains(&version)
81}
82
83/// Validate MCP protocol version compatibility
84///
85/// # Errors
86///
87/// Returns an error if the client version is not supported by this server
88pub fn validate_protocol_version(client_version: &str) -> Result<()> {
89 if is_protocol_version_supported(client_version) {
90 Ok(())
91 } else {
92 Err(Error::protocol_version_mismatch(
93 client_version,
94 MCP_VERSION,
95 ))
96 }
97}