mcpkit-core 0.6.0

Core types and traits for the Model Context Protocol (MCP)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
//! Session recording and replay utilities.
//!
//! The session recorder captures entire MCP sessions for later
//! analysis, testing, or replay.

use crate::protocol::Message;
use serde::{Deserialize, Serialize};
use std::sync::{Arc, RwLock};
use std::time::{Duration, Instant, SystemTime};

/// A recorded MCP session.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RecordedSession {
    /// Session name/identifier.
    pub name: String,
    /// When the recording started.
    pub started_at: SystemTime,
    /// Total duration of the session.
    #[serde(with = "duration_serde")]
    pub duration: Duration,
    /// Recorded events.
    pub events: Vec<SessionEvent>,
    /// Session metadata.
    pub metadata: SessionMetadata,
}

impl RecordedSession {
    /// Create a new empty session.
    #[must_use]
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            started_at: SystemTime::now(),
            duration: Duration::ZERO,
            events: Vec::new(),
            metadata: SessionMetadata::default(),
        }
    }

    /// Get the number of events.
    #[must_use]
    pub fn len(&self) -> usize {
        self.events.len()
    }

    /// Check if empty.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.events.is_empty()
    }

    /// Get only messages (excluding lifecycle events).
    #[must_use]
    pub fn messages(&self) -> Vec<&Message> {
        self.events
            .iter()
            .filter_map(|e| match e {
                SessionEvent::MessageSent { message, .. }
                | SessionEvent::MessageReceived { message, .. } => Some(message),
                _ => None,
            })
            .collect()
    }

    /// Get events within a time range.
    #[must_use]
    pub fn events_in_range(&self, start: Duration, end: Duration) -> Vec<&SessionEvent> {
        self.events
            .iter()
            .filter(|e| {
                let offset = e.offset();
                offset >= start && offset <= end
            })
            .collect()
    }

    /// Export to JSON.
    ///
    /// # Errors
    ///
    /// Returns an error if serialization fails.
    pub fn to_json(&self) -> Result<String, serde_json::Error> {
        serde_json::to_string_pretty(self)
    }

    /// Import from JSON.
    ///
    /// # Errors
    ///
    /// Returns an error if deserialization fails.
    pub fn from_json(json: &str) -> Result<Self, serde_json::Error> {
        serde_json::from_str(json)
    }
}

/// Session metadata.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SessionMetadata {
    /// Client name.
    pub client_name: Option<String>,
    /// Client version.
    pub client_version: Option<String>,
    /// Server name.
    pub server_name: Option<String>,
    /// Server version.
    pub server_version: Option<String>,
    /// Transport type.
    pub transport: Option<String>,
    /// Protocol version.
    pub protocol_version: Option<String>,
    /// Custom tags.
    pub tags: Vec<String>,
}

/// A session event.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum SessionEvent {
    /// Session started.
    SessionStarted {
        /// Offset from session start.
        #[serde(with = "duration_serde")]
        offset: Duration,
    },
    /// Message sent by client.
    MessageSent {
        /// Offset from session start.
        #[serde(with = "duration_serde")]
        offset: Duration,
        /// The message.
        message: Message,
    },
    /// Message received by client.
    MessageReceived {
        /// Offset from session start.
        #[serde(with = "duration_serde")]
        offset: Duration,
        /// The message.
        message: Message,
    },
    /// Error occurred.
    Error {
        /// Offset from session start.
        #[serde(with = "duration_serde")]
        offset: Duration,
        /// Error message.
        error: String,
    },
    /// Session ended.
    SessionEnded {
        /// Offset from session start.
        #[serde(with = "duration_serde")]
        offset: Duration,
        /// Reason for ending.
        reason: Option<String>,
    },
    /// Custom event.
    Custom {
        /// Offset from session start.
        #[serde(with = "duration_serde")]
        offset: Duration,
        /// Event name.
        name: String,
        /// Event data.
        data: serde_json::Value,
    },
}

impl SessionEvent {
    /// Get the offset from session start.
    #[must_use]
    pub fn offset(&self) -> Duration {
        match self {
            Self::SessionStarted { offset }
            | Self::MessageSent { offset, .. }
            | Self::MessageReceived { offset, .. }
            | Self::Error { offset, .. }
            | Self::SessionEnded { offset, .. }
            | Self::Custom { offset, .. } => *offset,
        }
    }
}

/// Session recorder for capturing MCP sessions.
pub struct SessionRecorder {
    /// Session name.
    name: String,
    /// When recording started.
    started: Instant,
    /// Recording state.
    state: Arc<RwLock<RecorderState>>,
}

struct RecorderState {
    /// Recorded events.
    events: Vec<SessionEvent>,
    /// Whether recording is active.
    recording: bool,
    /// Session metadata.
    metadata: SessionMetadata,
}

impl SessionRecorder {
    /// Create a new session recorder.
    #[must_use]
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            started: Instant::now(),
            state: Arc::new(RwLock::new(RecorderState {
                events: vec![SessionEvent::SessionStarted {
                    offset: Duration::ZERO,
                }],
                recording: true,
                metadata: SessionMetadata::default(),
            })),
        }
    }

    /// Set session metadata.
    pub fn set_metadata(&self, metadata: SessionMetadata) {
        if let Ok(mut state) = self.state.write() {
            state.metadata = metadata;
        }
    }

    /// Check if recording is active.
    #[must_use]
    pub fn is_recording(&self) -> bool {
        self.state.read().is_ok_and(|s| s.recording)
    }

    /// Stop recording.
    pub fn stop(&self, reason: Option<String>) {
        if let Ok(mut state) = self.state.write() {
            if state.recording {
                state.events.push(SessionEvent::SessionEnded {
                    offset: self.started.elapsed(),
                    reason,
                });
                state.recording = false;
            }
        }
    }

    /// Record a sent message.
    pub fn record_sent(&self, message: Message) {
        if let Ok(mut state) = self.state.write() {
            if state.recording {
                state.events.push(SessionEvent::MessageSent {
                    offset: self.started.elapsed(),
                    message,
                });
            }
        }
    }

    /// Record a received message.
    pub fn record_received(&self, message: Message) {
        if let Ok(mut state) = self.state.write() {
            if state.recording {
                state.events.push(SessionEvent::MessageReceived {
                    offset: self.started.elapsed(),
                    message,
                });
            }
        }
    }

    /// Record an error.
    pub fn record_error(&self, error: impl Into<String>) {
        if let Ok(mut state) = self.state.write() {
            if state.recording {
                state.events.push(SessionEvent::Error {
                    offset: self.started.elapsed(),
                    error: error.into(),
                });
            }
        }
    }

    /// Record a custom event.
    pub fn record_custom(&self, name: impl Into<String>, data: serde_json::Value) {
        if let Ok(mut state) = self.state.write() {
            if state.recording {
                state.events.push(SessionEvent::Custom {
                    offset: self.started.elapsed(),
                    name: name.into(),
                    data,
                });
            }
        }
    }

    /// Get the number of recorded events.
    #[must_use]
    pub fn event_count(&self) -> usize {
        self.state.read().map_or(0, |s| s.events.len())
    }

    /// Finalize and return the recorded session.
    #[must_use]
    pub fn finalize(self) -> RecordedSession {
        self.stop(Some("finalized".to_string()));

        let (events, metadata) = self
            .state
            .read()
            .map(|s| (s.events.clone(), s.metadata.clone()))
            .unwrap_or_default();

        RecordedSession {
            name: self.name,
            started_at: SystemTime::now() - self.started.elapsed(),
            duration: self.started.elapsed(),
            events,
            metadata,
        }
    }
}

impl Clone for SessionRecorder {
    fn clone(&self) -> Self {
        Self {
            name: self.name.clone(),
            started: self.started,
            state: Arc::clone(&self.state),
        }
    }
}

/// Serde support for Duration.
mod duration_serde {
    use serde::{Deserialize, Deserializer, Serialize, Serializer};
    use std::time::Duration;

    pub fn serialize<S>(duration: &Duration, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        duration.as_millis().serialize(serializer)
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<Duration, D::Error>
    where
        D: Deserializer<'de>,
    {
        let ms = u64::deserialize(deserializer)?;
        Ok(Duration::from_millis(ms))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::protocol::{Request, RequestId, Response};

    #[test]
    fn test_session_recorder() {
        let recorder = SessionRecorder::new("test-session");

        recorder.record_sent(Message::Request(Request::new("test/method", 1)));
        recorder.record_received(Message::Response(Response::success(
            RequestId::from(1),
            serde_json::json!({}),
        )));

        assert_eq!(recorder.event_count(), 3); // start + 2 messages
        assert!(recorder.is_recording());

        let session = recorder.finalize();
        assert_eq!(session.name, "test-session");
        assert_eq!(session.events.len(), 4); // start + 2 messages + end
    }

    #[test]
    fn test_session_serialization() {
        let recorder = SessionRecorder::new("test");
        recorder.record_sent(Message::Request(Request::new("ping", 1)));
        let session = recorder.finalize();

        let json = session.to_json().expect("Failed to serialize");
        let restored = RecordedSession::from_json(&json).expect("Failed to deserialize");

        assert_eq!(restored.name, "test");
        assert_eq!(restored.events.len(), session.events.len());
    }

    #[test]
    fn test_session_metadata() {
        let recorder = SessionRecorder::new("test");

        let metadata = SessionMetadata {
            client_name: Some("test-client".to_string()),
            client_version: Some("1.0.0".to_string()),
            ..Default::default()
        };

        recorder.set_metadata(metadata);

        let session = recorder.finalize();
        assert_eq!(
            session.metadata.client_name,
            Some("test-client".to_string())
        );
    }
}