pmcp 2.2.0

High-quality Rust SDK for Model Context Protocol (MCP) with full TypeScript SDK compatibility
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
//! WebSocket transport implementation for MCP.

use crate::error::Result;
use crate::shared::{Transport, TransportMessage};
use async_trait::async_trait;
use futures::{SinkExt, StreamExt};
use parking_lot::RwLock;
use std::sync::Arc;
use std::time::Duration;
#[cfg(not(target_arch = "wasm32"))]
use tokio::sync::mpsc;
#[cfg(not(target_arch = "wasm32"))]
use tokio::sync::Mutex as AsyncMutex;
#[cfg(not(target_arch = "wasm32"))]
use tokio::time::{interval, sleep};
use tokio_tungstenite::{connect_async, tungstenite::protocol::Message};
use tracing::{debug, error, info, warn};
use url::Url;

/// WebSocket transport configuration.
#[derive(Debug, Clone)]
pub struct WebSocketConfig {
    /// WebSocket URL to connect to
    pub url: Url,
    /// Enable automatic reconnection
    pub auto_reconnect: bool,
    /// Initial reconnection delay (doubles on each attempt)
    pub reconnect_delay: Duration,
    /// Maximum reconnection delay
    pub max_reconnect_delay: Duration,
    /// Maximum number of reconnection attempts (None = infinite)
    pub max_reconnect_attempts: Option<u32>,
    /// Ping interval for keepalive
    pub ping_interval: Option<Duration>,
    /// Request timeout
    pub request_timeout: Duration,
}

impl Default for WebSocketConfig {
    fn default() -> Self {
        Self {
            url: "ws://localhost:8080".parse().expect("Valid default URL"),
            auto_reconnect: true,
            reconnect_delay: Duration::from_secs(1),
            max_reconnect_delay: Duration::from_secs(60),
            max_reconnect_attempts: None,
            ping_interval: Some(Duration::from_secs(30)),
            request_timeout: Duration::from_secs(30),
        }
    }
}

/// WebSocket transport implementation.
pub struct WebSocketTransport {
    config: WebSocketConfig,
    state: Arc<RwLock<ConnectionState>>,
    message_tx: mpsc::Sender<TransportMessage>,
    message_rx: Arc<AsyncMutex<mpsc::Receiver<TransportMessage>>>,
}

#[derive(Debug)]
enum ConnectionState {
    Disconnected,
    Connecting,
    Connected,
    Closing,
}

impl std::fmt::Debug for WebSocketTransport {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("WebSocketTransport")
            .field("config", &self.config)
            .field("state", &self.state)
            .finish_non_exhaustive()
    }
}

impl WebSocketTransport {
    /// Create a new WebSocket transport with the given configuration.
    pub fn new(config: WebSocketConfig) -> Self {
        let (tx, rx) = mpsc::channel(100);
        Self {
            config,
            state: Arc::new(RwLock::new(ConnectionState::Disconnected)),
            message_tx: tx,
            message_rx: Arc::new(AsyncMutex::new(rx)),
        }
    }

    /// Create a new WebSocket transport with default configuration.
    pub fn with_url(url: impl Into<Url>) -> Result<Self> {
        Ok(Self::new(WebSocketConfig {
            url: url.into(),
            ..Default::default()
        }))
    }

    /// Connect to the WebSocket server.
    pub async fn connect(&self) -> Result<()> {
        self.connect_with_retry().await
    }

    async fn connect_with_retry(&self) -> Result<()> {
        let mut attempts = 0;
        let mut delay = self.config.reconnect_delay;

        loop {
            match self.connect_once().await {
                Ok(()) => return Ok(()),
                Err(e) => {
                    attempts += 1;
                    if let Some(max) = self.config.max_reconnect_attempts {
                        if attempts >= max {
                            error!("Max reconnection attempts reached");
                            return Err(e);
                        }
                    }

                    warn!(
                        "Connection attempt {} failed: {}. Retrying in {:?}",
                        attempts, e, delay
                    );

                    sleep(delay).await;
                    delay = (delay * 2).min(self.config.max_reconnect_delay);
                },
            }
        }
    }

    async fn connect_once(&self) -> Result<()> {
        {
            let mut state = self.state.write();
            *state = ConnectionState::Connecting;
        }

        info!("Connecting to WebSocket at {}", self.config.url);

        let (ws_stream, _) = connect_async(self.config.url.as_str())
            .await
            .map_err(crate::error::TransportError::from)?;
        let (sink, stream) = ws_stream.split();

        {
            let mut state = self.state.write();
            *state = ConnectionState::Connected;
        }

        info!("WebSocket connected");

        // Spawn reader task
        let message_tx = self.message_tx.clone();
        let _reader_handle = tokio::spawn(async move {
            let mut stream = stream;
            while let Some(result) = stream.next().await {
                match result {
                    Ok(Message::Text(text)) => {
                        match serde_json::from_str::<serde_json::Value>(&text) {
                            Ok(_json) => {
                                // Parse the JSON value into a TransportMessage
                                match crate::shared::stdio::StdioTransport::parse_message(
                                    text.as_bytes(),
                                ) {
                                    Ok(msg) => {
                                        if message_tx.send(msg).await.is_err() {
                                            error!("Failed to send message to channel");
                                            break;
                                        }
                                    },
                                    Err(e) => {
                                        error!("Failed to parse message: {}", e);
                                    },
                                }
                            },
                            Err(e) => {
                                error!("Failed to parse WebSocket message: {}", e);
                            },
                        }
                    },
                    Ok(Message::Close(_)) => {
                        info!("WebSocket closed by remote");
                        break;
                    },
                    Ok(Message::Ping(data)) => {
                        debug!("Received ping: {:?}", data);
                    },
                    Ok(Message::Pong(_)) => {
                        debug!("Received pong");
                    },
                    Ok(Message::Binary(_)) => {
                        warn!("Received unexpected binary message");
                    },
                    Ok(Message::Frame(_)) => {
                        warn!("Received unexpected frame message");
                    },
                    Err(e) => {
                        error!("WebSocket error: {}", e);
                        break;
                    },
                }
            }
        });

        // Spawn writer task
        let (write_tx, mut write_rx) = mpsc::channel::<Message>(100);
        let _writer_handle = tokio::spawn(async move {
            let mut sink = sink;
            while let Some(msg) = write_rx.recv().await {
                if let Err(e) = sink.send(msg).await {
                    error!("Failed to send WebSocket message: {}", e);
                    break;
                }
            }
        });

        // Spawn ping task if configured
        if let Some(ping_interval) = self.config.ping_interval {
            tokio::spawn(async move {
                let mut ticker = interval(ping_interval);
                loop {
                    ticker.tick().await;
                    if write_tx.send(Message::Ping(vec![].into())).await.is_err() {
                        break;
                    }
                }
            });
        }

        // Store the writer channel for sending messages
        // This is a simplified approach - in production you'd want better state management

        Ok(())
    }
}

#[async_trait]
impl Transport for WebSocketTransport {
    async fn send(&mut self, message: TransportMessage) -> Result<()> {
        let json_bytes = crate::shared::stdio::StdioTransport::serialize_message(&message)?;
        let json = String::from_utf8(json_bytes).map_err(|e| {
            crate::error::Error::Transport(crate::error::TransportError::InvalidMessage(format!(
                "Invalid UTF-8: {}",
                e
            )))
        })?;

        // In a real implementation, we'd need to store the write channel
        // This is simplified for the example
        match &*self.state.read() {
            ConnectionState::Connected => {
                debug!("Sending WebSocket message: {}", json);
                Ok(())
            },
            _ => Err(crate::error::Error::Transport(
                crate::error::TransportError::ConnectionClosed,
            )),
        }
    }

    async fn receive(&mut self) -> Result<TransportMessage> {
        let mut rx = self.message_rx.lock().await;
        rx.recv().await.ok_or_else(|| {
            crate::error::Error::Transport(crate::error::TransportError::ConnectionClosed)
        })
    }

    async fn close(&mut self) -> Result<()> {
        {
            let mut state = self.state.write();
            *state = ConnectionState::Closing;
        }

        info!("Closing WebSocket connection");

        {
            let mut state = self.state.write();
            *state = ConnectionState::Disconnected;
        }

        Ok(())
    }

    fn is_connected(&self) -> bool {
        matches!(&*self.state.read(), ConnectionState::Connected)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_websocket_config_default() {
        let config = WebSocketConfig::default();
        assert!(config.auto_reconnect);
        assert_eq!(config.reconnect_delay, Duration::from_secs(1));
        assert_eq!(config.max_reconnect_delay, Duration::from_secs(60));
        assert!(config.max_reconnect_attempts.is_none());
        assert_eq!(config.ping_interval, Some(Duration::from_secs(30)));
        assert_eq!(config.request_timeout, Duration::from_secs(30));
        assert_eq!(config.url.as_str(), "ws://localhost:8080/");
    }

    #[test]
    fn test_websocket_config_custom() {
        let config = WebSocketConfig {
            url: "wss://example.com:9000/ws".parse().unwrap(),
            auto_reconnect: false,
            reconnect_delay: Duration::from_secs(2),
            max_reconnect_delay: Duration::from_secs(120),
            max_reconnect_attempts: Some(5),
            ping_interval: None,
            request_timeout: Duration::from_secs(60),
        };
        assert_eq!(config.url.as_str(), "wss://example.com:9000/ws");
        assert!(!config.auto_reconnect);
        assert_eq!(config.reconnect_delay, Duration::from_secs(2));
        assert_eq!(config.max_reconnect_attempts, Some(5));
        assert!(config.ping_interval.is_none());
    }

    #[test]
    fn test_websocket_transport_creation() {
        let config = WebSocketConfig::default();
        let transport = WebSocketTransport::new(config);
        assert!(!transport.is_connected());
    }

    #[test]
    fn test_websocket_transport_with_url() {
        let transport =
            WebSocketTransport::with_url("ws://test.example.com:3000".parse::<Url>().unwrap())
                .unwrap();
        assert!(!transport.is_connected());
        assert_eq!(transport.config.url.as_str(), "ws://test.example.com:3000/");
    }

    #[test]
    fn test_websocket_config_clone() {
        let config = WebSocketConfig::default();
        let cloned = config.clone();
        assert_eq!(config.url, cloned.url);
        assert_eq!(config.auto_reconnect, cloned.auto_reconnect);
        assert_eq!(config.reconnect_delay, cloned.reconnect_delay);
    }

    #[test]
    fn test_websocket_transport_debug() {
        let config = WebSocketConfig::default();
        let transport = WebSocketTransport::new(config);
        let debug_str = format!("{:?}", transport);
        assert!(debug_str.contains("WebSocketTransport"));
        assert!(debug_str.contains("config"));
        assert!(debug_str.contains("state"));
    }

    #[test]
    fn test_connection_state_transitions() {
        let state = Arc::new(RwLock::new(ConnectionState::Disconnected));

        // Initial state
        assert!(matches!(&*state.read(), ConnectionState::Disconnected));

        // Transition to connecting
        {
            let mut s = state.write();
            *s = ConnectionState::Connecting;
        }
        assert!(matches!(&*state.read(), ConnectionState::Connecting));

        // Transition to connected
        {
            let mut s = state.write();
            *s = ConnectionState::Connected;
        }
        assert!(matches!(&*state.read(), ConnectionState::Connected));

        // Transition to closing
        {
            let mut s = state.write();
            *s = ConnectionState::Closing;
        }
        assert!(matches!(&*state.read(), ConnectionState::Closing));

        // Back to disconnected
        {
            let mut s = state.write();
            *s = ConnectionState::Disconnected;
        }
        assert!(matches!(&*state.read(), ConnectionState::Disconnected));
    }

    #[tokio::test]
    async fn test_websocket_close() {
        let config = WebSocketConfig::default();
        let mut transport = WebSocketTransport::new(config);

        // Set to connected state
        {
            let mut state = transport.state.write();
            *state = ConnectionState::Connected;
        }
        assert!(transport.is_connected());

        // Close should transition through states
        transport.close().await.unwrap();
        assert!(!transport.is_connected());
        assert!(matches!(
            &*transport.state.read(),
            ConnectionState::Disconnected
        ));
    }

    #[tokio::test]
    async fn test_send_when_not_connected() {
        use crate::types::{ClientRequest, Request, RequestId};

        let config = WebSocketConfig::default();
        let mut transport = WebSocketTransport::new(config);

        let message = TransportMessage::Request {
            id: RequestId::from(1i64),
            request: Request::Client(Box::new(ClientRequest::Ping)),
        };

        // Should fail when not connected
        let result = transport.send(message).await;
        assert!(result.is_err());
        if let Err(crate::error::Error::Transport(e)) = result {
            assert!(matches!(e, crate::error::TransportError::ConnectionClosed));
        }
    }

    #[tokio::test]
    async fn test_send_when_connected() {
        use crate::types::{ClientRequest, Request, RequestId};

        let config = WebSocketConfig::default();
        let mut transport = WebSocketTransport::new(config);

        // Set to connected state
        {
            let mut state = transport.state.write();
            *state = ConnectionState::Connected;
        }

        let message = TransportMessage::Request {
            id: RequestId::from(1i64),
            request: Request::Client(Box::new(ClientRequest::Ping)),
        };

        // Should succeed when connected (though simplified implementation just returns Ok)
        let result = transport.send(message).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_receive_when_channel_closed() {
        let config = WebSocketConfig::default();
        let transport = WebSocketTransport::new(config);

        // Create a new receiver that's already closed
        let (_, rx) = mpsc::channel::<TransportMessage>(1);
        let mut transport = WebSocketTransport {
            config: transport.config,
            state: transport.state,
            message_tx: transport.message_tx,
            message_rx: Arc::new(AsyncMutex::new(rx)),
        };

        // Receive should error with ConnectionClosed
        let result = transport.receive().await;
        assert!(result.is_err());
        if let Err(crate::error::Error::Transport(e)) = result {
            assert!(matches!(e, crate::error::TransportError::ConnectionClosed));
        }
    }

    #[test]
    fn test_websocket_config_with_finite_retries() {
        let config = WebSocketConfig {
            url: "ws://localhost:8080".parse().unwrap(),
            auto_reconnect: true,
            max_reconnect_attempts: Some(3),
            ..Default::default()
        };
        assert_eq!(config.max_reconnect_attempts, Some(3));
    }

    #[test]
    fn test_websocket_config_with_no_ping() {
        let config = WebSocketConfig {
            url: "ws://localhost:8080".parse().unwrap(),
            ping_interval: None,
            ..Default::default()
        };
        assert!(config.ping_interval.is_none());
    }
}