mcpx 0.1.5

A Rust SDK 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
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
//! Basic message types for the MCP protocol

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use super::ProgressToken;

/// A request that expects a response.
pub trait Request {
    /// Method name constant
    const METHOD: &'static str;

    /// Get the method name
    fn method(&self) -> &str;

    /// Get the parameters
    fn params(&self) -> Option<&serde_json::Value>;
}

/// A concrete request implementation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RequestImpl {
    /// Method name
    pub method: String,
    /// Optional parameters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<serde_json::Value>,
}

impl Request for RequestImpl {
    const METHOD: &'static str = "";

    fn method(&self) -> &str {
        &self.method
    }

    fn params(&self) -> Option<&serde_json::Value> {
        self.params.as_ref()
    }
}

impl RequestImpl {
    /// Create a new request
    pub fn new(method: impl Into<String>) -> Self {
        Self {
            method: method.into(),
            params: None,
        }
    }

    /// Create a new request with parameters
    pub fn with_params(method: impl Into<String>, params: serde_json::Value) -> Self {
        Self {
            method: method.into(),
            params: Some(params),
        }
    }
}

impl RequestImpl {
    /// Create a new request with a progress token
    pub fn with_progress_token(method: impl Into<String>, progress_token: ProgressToken) -> Self {
        let mut params = serde_json::Map::new();
        params.insert("progressToken".to_string(), serde_json::to_value(progress_token).unwrap());
        Self {
            method: method.into(),
            params: Some(serde_json::Value::Object(params)),
        }
    }
}

/// A notification that does not expect a response.
pub trait Notification {
    /// Method name constant
    const METHOD: &'static str;

    /// Get the method name
    fn method(&self) -> &str;

    /// Get the parameters
    fn params(&self) -> Option<&serde_json::Value>;
}

/// A concrete notification implementation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct NotificationImpl {
    /// Method name
    pub method: String,
    /// Optional parameters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<serde_json::Value>,
}

impl Notification for NotificationImpl {
    const METHOD: &'static str = "";

    fn method(&self) -> &str {
        &self.method
    }

    fn params(&self) -> Option<&serde_json::Value> {
        self.params.as_ref()
    }
}

impl NotificationImpl {
    /// Create a new notification
    pub fn new(method: impl Into<String>) -> Self {
        Self {
            method: method.into(),
            params: None,
        }
    }

    /// Create a new notification with parameters
    pub fn with_params(method: impl Into<String>, params: serde_json::Value) -> Self {
        Self {
            method: method.into(),
            params: Some(params),
        }
    }
}

/// Parameters for a request
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RequestParams {
    /// Metadata for the request
    #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
    pub meta: Option<RequestMeta>,
    /// Additional parameters (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

impl RequestParams {
    /// Create empty request parameters
    pub fn new() -> Self {
        Self {
            meta: None,
            additional: HashMap::new(),
        }
    }

    /// Add a progress token to the request parameters
    pub fn set_progress_token(&mut self, token: ProgressToken) {
        if self.meta.is_none() {
            self.meta = Some(RequestMeta {
                progress_token: Some(token),
            });
        } else if let Some(meta) = &mut self.meta {
            meta.progress_token = Some(token);
        }
    }

    /// Add a parameter to the request
    pub fn add<T: Serialize>(&mut self, name: impl Into<String>, value: &T) -> std::result::Result<(), serde_json::Error> {
        self.additional.insert(name.into(), serde_json::to_value(value)?);
        Ok(())
    }
}

impl Default for RequestParams {
    fn default() -> Self {
        Self::new()
    }
}

/// Metadata for a request
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RequestMeta {
    /// Progress token for the request
    #[serde(rename = "progressToken", skip_serializing_if = "Option::is_none")]
    pub progress_token: Option<ProgressToken>,
}

/// Parameters for a notification
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct NotificationParams {
    /// Metadata for the notification
    #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
    pub meta: Option<NotificationMeta>,
    /// Additional parameters (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

impl NotificationParams {
    /// Create empty notification parameters
    pub fn new() -> Self {
        Self {
            meta: None,
            additional: HashMap::new(),
        }
    }

    /// Add a parameter to the notification
    pub fn add<T: Serialize>(&mut self, name: impl Into<String>, value: &T) -> std::result::Result<(), serde_json::Error> {
        self.additional.insert(name.into(), serde_json::to_value(value)?);
        Ok(())
    }
}

impl Default for NotificationParams {
    fn default() -> Self {
        Self::new()
    }
}

/// Metadata for a notification
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct NotificationMeta {
    /// Additional metadata (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

impl NotificationMeta {
    /// Create empty notification metadata
    pub fn new() -> Self {
        Self {
            additional: HashMap::new(),
        }
    }

    /// Add a metadata field to the notification
    pub fn add<T: Serialize>(&mut self, name: impl Into<String>, value: &T) -> std::result::Result<(), serde_json::Error> {
        self.additional.insert(name.into(), serde_json::to_value(value)?);
        Ok(())
    }
}

impl Default for NotificationMeta {
    fn default() -> Self {
        Self::new()
    }
}

/// A result returned by a request handler
pub trait MessageResult {}

/// A concrete result implementation
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Result {
    /// Metadata for the result
    #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
    pub meta: Option<ResultMeta>,
    /// Additional fields (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

impl MessageResult for Result {}

impl Result {
    /// Create an empty result
    pub fn new() -> Self {
        Self {
            meta: None,
            additional: HashMap::new(),
        }
    }

    /// Add a field to the result
    pub fn add<T: Serialize>(&mut self, name: impl Into<String>, value: &T) -> std::result::Result<(), serde_json::Error> {
        self.additional.insert(name.into(), serde_json::to_value(value)?);
        Ok(())
    }
}

impl Default for Result {
    fn default() -> Self {
        Self::new()
    }
}

/// Metadata for a result
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ResultMeta {
    /// Additional metadata (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

impl ResultMeta {
    /// Create empty result metadata
    pub fn new() -> Self {
        Self {
            additional: HashMap::new(),
        }
    }

    /// Add a metadata field to the result
    pub fn add<T: Serialize>(&mut self, name: impl Into<String>, value: &T) -> std::result::Result<(), serde_json::Error> {
        self.additional.insert(name.into(), serde_json::to_value(value)?);
        Ok(())
    }
}

impl Default for ResultMeta {
    fn default() -> Self {
        Self::new()
    }
}

/// An empty result with no additional fields
pub type EmptyResult = Result;

/// A paginated request with a cursor parameter
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct PaginatedRequest {
    /// Method name
    pub method: String,
    /// Optional parameters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<PaginatedRequestParams>,
}

impl PaginatedRequest {
    /// Create a new paginated request
    pub fn new(method: impl Into<String>) -> Self {
        Self {
            method: method.into(),
            params: None,
        }
    }

    /// Create a new paginated request with a cursor
    pub fn with_cursor(method: impl Into<String>, cursor: impl Into<String>) -> Self {
        let params = PaginatedRequestParams {
            cursor: Some(cursor.into()),
            meta: None,
            additional: HashMap::new(),
        };

        Self {
            method: method.into(),
            params: Some(params),
        }
    }
}

/// Parameters for a paginated request
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct PaginatedRequestParams {
    /// Cursor for pagination
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<String>,
    /// Metadata for the request
    #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
    pub meta: Option<RequestMeta>,
    /// Additional parameters (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

/// A paginated result with a next cursor
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct PaginatedResult {
    /// Cursor for the next page, if any
    #[serde(rename = "nextCursor", skip_serializing_if = "Option::is_none")]
    pub next_cursor: Option<String>,
    /// Metadata for the result
    #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
    pub meta: Option<ResultMeta>,
    /// Additional fields (method-specific)
    #[serde(flatten)]
    pub additional: HashMap<String, serde_json::Value>,
}

impl PaginatedResult {
    /// Create a new paginated result
    pub fn new() -> Self {
        Self {
            next_cursor: None,
            meta: None,
            additional: HashMap::new(),
        }
    }

    /// Create a new paginated result with a next cursor
    pub fn with_next_cursor(next_cursor: impl Into<String>) -> Self {
        Self {
            next_cursor: Some(next_cursor.into()),
            meta: None,
            additional: HashMap::new(),
        }
    }

    /// Add a field to the result
    pub fn add<T: Serialize>(&mut self, name: impl Into<String>, value: &T) -> std::result::Result<(), serde_json::Error> {
        self.additional.insert(name.into(), serde_json::to_value(value)?);
        Ok(())
    }
}

impl Default for PaginatedResult {
    fn default() -> Self {
        Self::new()
    }
}

/// Standard MCP cancel notification
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CancelledNotification {
    /// Method is always "notifications/cancelled"
    pub method: String,
    /// Parameters for the cancellation
    pub params: CancelledParams,
}

/// Parameters for a cancel notification
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CancelledParams {
    /// The ID of the request to cancel
    #[serde(rename = "requestId")]
    pub request_id: super::RequestId,
    /// Optional reason for cancellation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
}

impl CancelledNotification {
    /// Create a new cancelled notification
    pub fn new<I: Into<super::RequestId>>(request_id: I) -> Self {
        Self {
            method: "notifications/cancelled".to_string(),
            params: CancelledParams {
                request_id: request_id.into(),
                reason: None,
            },
        }
    }

    /// Create a new cancelled notification with a reason
    pub fn with_reason<I: Into<super::RequestId>>(request_id: I, reason: impl Into<String>) -> Self {
        Self {
            method: "notifications/cancelled".to_string(),
            params: CancelledParams {
                request_id: request_id.into(),
                reason: Some(reason.into()),
            },
        }
    }
}

/// Standard MCP progress notification
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ProgressNotification {
    /// Method is always "notifications/progress"
    pub method: String,
    /// Parameters for the progress notification
    pub params: ProgressParams,
}

/// Parameters for a progress notification
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ProgressParams {
    /// Progress token from the original request
    #[serde(rename = "progressToken")]
    pub progress_token: ProgressToken,
    /// Current progress value
    pub progress: f64,
    /// Total progress value, if known
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total: Option<f64>,
    /// Optional progress message
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

impl ProgressNotification {
    /// Create a new progress notification
    pub fn new(progress_token: ProgressToken, progress: f64) -> Self {
        Self {
            method: "notifications/progress".to_string(),
            params: ProgressParams {
                progress_token,
                progress,
                total: None,
                message: None,
            },
        }
    }

    /// Create a new progress notification with a total
    pub fn with_total(progress_token: ProgressToken, progress: f64, total: f64) -> Self {
        Self {
            method: "notifications/progress".to_string(),
            params: ProgressParams {
                progress_token,
                progress,
                total: Some(total),
                message: None,
            },
        }
    }

    /// Create a new progress notification with a message
    pub fn with_message(progress_token: ProgressToken, progress: f64, message: impl Into<String>) -> Self {
        Self {
            method: "notifications/progress".to_string(),
            params: ProgressParams {
                progress_token,
                progress,
                total: None,
                message: Some(message.into()),
            },
        }
    }

    /// Create a new progress notification with a total and message
    pub fn with_total_and_message(
        progress_token: ProgressToken,
        progress: f64,
        total: f64,
        message: impl Into<String>,
    ) -> Self {
        Self {
            method: "notifications/progress".to_string(),
            params: ProgressParams {
                progress_token,
                progress,
                total: Some(total),
                message: Some(message.into()),
            },
        }
    }
}