mcpkit 0.5.0

Rust SDK for the Model Context Protocol (MCP) - the official facade crate providing unified access to all mcpkit functionality
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
//! Integration tests for resource handling.

use mcpkit::capability::{ClientCapabilities, ServerCapabilities};
use mcpkit::protocol::RequestId;
use mcpkit::protocol_version::ProtocolVersion;
use mcpkit::types::resource::ResourceContents;
use mcpkit_server::capability::resources::{
    ResourceBuilder, ResourceService, ResourceTemplateBuilder,
};
use mcpkit_server::context::{Context, NoOpPeer};
use mcpkit_server::handler::ResourceHandler;

fn make_test_context() -> (
    RequestId,
    ClientCapabilities,
    ServerCapabilities,
    ProtocolVersion,
    NoOpPeer,
) {
    (
        RequestId::Number(1),
        ClientCapabilities::default(),
        ServerCapabilities::default(),
        ProtocolVersion::LATEST,
        NoOpPeer,
    )
}

#[tokio::test]
async fn test_resource_service_basic() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    let resource = ResourceBuilder::new("file:///config.json", "Config")
        .description("Application configuration")
        .mime_type("application/json")
        .build();

    service.register(resource, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, r#"{"debug": true}"#)) }
    });

    assert!(!service.is_empty());
    assert_eq!(service.len(), 1);
    Ok(())
}

#[tokio::test]
async fn test_resource_read() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    let resource = ResourceBuilder::new("file:///data.txt", "Data File")
        .description("Sample data")
        .mime_type("text/plain")
        .build();

    service.register(resource, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, "Hello, World!")) }
    });

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    let result = service.read("file:///data.txt", &ctx).await;
    assert!(result.is_ok());

    let contents = result?;
    assert_eq!(contents.uri, "file:///data.txt");
    Ok(())
}

#[tokio::test]
async fn test_resource_not_found() -> Result<(), Box<dyn std::error::Error>> {
    let service = ResourceService::new();

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    let result = service.read("file:///nonexistent.txt", &ctx).await;
    assert!(result.is_err());
    Ok(())
}

#[tokio::test]
async fn test_resource_template() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    let template = ResourceTemplateBuilder::new("db://users/{id}", "User Record")
        .description("User data by ID")
        .mime_type("application/json")
        .build();

    service.register_template(template, |uri, _ctx| {
        let uri = uri.to_string();
        async move {
            // Extract ID from URI (simplified)
            let id = uri.strip_prefix("db://users/").unwrap_or("unknown");
            Ok(ResourceContents::text(
                uri.clone(),
                format!(r#"{{"id": "{id}", "name": "User {id}"}}"#),
            ))
        }
    });

    assert_eq!(service.template_count(), 1);

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    let result = service.read("db://users/123", &ctx).await;
    assert!(result.is_ok());
    Ok(())
}

#[tokio::test]
async fn test_resource_handler_trait() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    let resource = ResourceBuilder::new("mem://test", "Test Resource")
        .description("A test resource")
        .build();

    service.register(resource, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, "test content")) }
    });

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    // Use the ResourceHandler trait
    let resources = service.list_resources(&ctx).await?;
    assert_eq!(resources.len(), 1);

    let contents = service.read_resource("mem://test", &ctx).await?;
    assert_eq!(contents.len(), 1);
    Ok(())
}

#[tokio::test]
async fn test_resource_builder() -> Result<(), Box<dyn std::error::Error>> {
    let resource = ResourceBuilder::new("file:///example.md", "Example")
        .description("An example file")
        .mime_type("text/markdown")
        .build();

    assert_eq!(resource.uri, "file:///example.md");
    assert_eq!(resource.name, "Example");
    assert_eq!(resource.description.as_deref(), Some("An example file"));
    assert_eq!(resource.mime_type.as_deref(), Some("text/markdown"));
    Ok(())
}

#[tokio::test]
async fn test_resource_template_builder() -> Result<(), Box<dyn std::error::Error>> {
    let template = ResourceTemplateBuilder::new("api://data/{category}/{id}", "API Data")
        .description("Fetch data from API")
        .mime_type("application/json")
        .build();

    assert_eq!(template.uri_template, "api://data/{category}/{id}");
    assert_eq!(template.name, "API Data");
    assert_eq!(template.description.as_deref(), Some("Fetch data from API"));
    Ok(())
}

#[tokio::test]
async fn test_multiple_resources() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    for i in 1..=5 {
        let resource =
            ResourceBuilder::new(format!("file:///file{i}.txt"), format!("File {i}")).build();

        service.register(resource, move |uri, _ctx| {
            let uri = uri.to_string();
            async move { Ok(ResourceContents::text(uri, "Content of file".to_string())) }
        });
    }

    assert_eq!(service.len(), 5);

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    let resources = service.list_resources(&ctx).await?;
    assert_eq!(resources.len(), 5);
    Ok(())
}

#[tokio::test]
async fn test_binary_resource() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    let resource = ResourceBuilder::new("file:///image.png", "Image")
        .mime_type("image/png")
        .build();

    service.register(resource, |uri, _ctx| {
        let uri = uri.to_string();
        async move {
            // Simulate binary content as blob
            Ok(ResourceContents::blob(
                uri,
                &[0x89, 0x50, 0x4E, 0x47],
                "image/png",
            ))
        }
    });

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    let result = service.read("file:///image.png", &ctx).await;
    assert!(result.is_ok());
    Ok(())
}

#[tokio::test]
async fn test_resource_template_uri_matching() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    // Register a template with multiple path segments
    let template =
        ResourceTemplateBuilder::new("db://{database}/tables/{table}/rows/{id}", "DB Row")
            .description("Database row by ID")
            .mime_type("application/json")
            .build();

    service.register_template(template, |uri, _ctx| {
        let uri = uri.to_string();
        async move {
            Ok(ResourceContents::text(
                uri.clone(),
                format!(r#"{{"uri": "{uri}"}}"#),
            ))
        }
    });

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    // Should match with specific values
    let result = service.read("db://mydb/tables/users/rows/123", &ctx).await;
    assert!(result.is_ok());

    // Should also match with different values
    let result = service.read("db://prod/tables/orders/rows/456", &ctx).await;
    assert!(result.is_ok());
    Ok(())
}

#[tokio::test]
async fn test_resource_template_with_special_characters() -> Result<(), Box<dyn std::error::Error>>
{
    let mut service = ResourceService::new();

    // Template that might receive URL-encoded values
    let template = ResourceTemplateBuilder::new("search://{query}", "Search")
        .description("Search query")
        .build();

    service.register_template(template, |uri, _ctx| {
        let uri = uri.to_string();
        async move {
            Ok(ResourceContents::text(
                uri.clone(),
                "Search results".to_string(),
            ))
        }
    });

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    // Should work with simple query
    let result = service.read("search://hello", &ctx).await;
    assert!(result.is_ok());

    // Should work with query containing special chars (URL encoded)
    let result = service.read("search://hello%20world", &ctx).await;
    assert!(result.is_ok());
    Ok(())
}

#[tokio::test]
async fn test_resource_template_priority_over_exact() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    // Register an exact resource
    let resource = ResourceBuilder::new("file:///exact.txt", "Exact File").build();

    service.register(resource, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, "Exact content".to_string())) }
    });

    // Register a template that could also match
    let template = ResourceTemplateBuilder::new("file:///{filename}", "Any File").build();

    service.register_template(template, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, "Template content".to_string())) }
    });

    let (req_id, client_caps, server_caps, protocol_version, peer) = make_test_context();
    let ctx = Context::new(
        &req_id,
        None,
        &client_caps,
        &server_caps,
        protocol_version,
        &peer,
    );

    // Exact match should take priority
    let result = service.read("file:///exact.txt", &ctx).await;
    assert!(result.is_ok());
    let contents = result?;
    // The exact resource handler returns "Exact content"
    let text = contents.text.as_ref().ok_or("Expected text content")?;
    assert!(text.contains("Exact") || text.contains("exact"));

    // Non-exact should fall through to template
    let result = service.read("file:///other.txt", &ctx).await;
    assert!(result.is_ok());
    Ok(())
}

#[tokio::test]
async fn test_list_resource_templates() -> Result<(), Box<dyn std::error::Error>> {
    let mut service = ResourceService::new();

    // Register multiple templates
    let template1 = ResourceTemplateBuilder::new("api://v1/{endpoint}", "API v1")
        .description("Version 1 API")
        .build();

    let template2 = ResourceTemplateBuilder::new("api://v2/{endpoint}", "API v2")
        .description("Version 2 API")
        .build();

    service.register_template(template1, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, "v1 response".to_string())) }
    });

    service.register_template(template2, |uri, _ctx| {
        let uri = uri.to_string();
        async move { Ok(ResourceContents::text(uri, "v2 response".to_string())) }
    });

    let templates = service.list_templates();
    assert_eq!(templates.len(), 2);

    // Check template names
    let names: Vec<_> = templates.iter().map(|t| t.name.as_str()).collect();
    assert!(names.contains(&"API v1"));
    assert!(names.contains(&"API v2"));
    Ok(())
}