turul-mcp-server 0.3.34

High-level framework for building Model Context Protocol (MCP) servers
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
//! Pagination Integration Tests
//!
//! Tests for MCP pagination features (current spec: 2025-11-25).

use crate::handlers::{McpHandler, ResourcesListHandler};
use async_trait::async_trait;
use serde_json::{Value, json};
use turul_mcp_protocol::meta::PaginatedResponse;
use turul_mcp_protocol::resources::{ListResourcesResult, ResourceContent};

// Simple test resource for pagination
#[derive(Clone)]
struct TestResource {
    id: String,
    uri: String,
}

impl TestResource {
    fn new(id: impl Into<String>) -> Self {
        let id_str = id.into();
        Self {
            uri: format!("test://item/{}", id_str),
            id: id_str,
        }
    }
}

#[async_trait]
impl crate::McpResource for TestResource {
    async fn read(
        &self,
        _params: Option<Value>,
        _session: Option<&crate::SessionContext>,
    ) -> crate::McpResult<Vec<ResourceContent>> {
        Ok(vec![ResourceContent::text(
            format!("test://item/{}", self.id),
            format!("Test content for {}", self.id),
        )])
    }
}

// Required trait implementations for TestResource
use turul_mcp_builders::prelude::*; // HasResourceMetadata, HasResourceDescription, etc.

impl HasResourceMetadata for TestResource {
    fn name(&self) -> &str {
        "test_resource"
    }
}

impl HasResourceDescription for TestResource {
    fn description(&self) -> Option<&str> {
        Some("Test resource for pagination")
    }
}

impl HasResourceUri for TestResource {
    fn uri(&self) -> &str {
        &self.uri
    }
}

impl HasResourceMimeType for TestResource {}
impl HasResourceSize for TestResource {}
impl HasResourceAnnotations for TestResource {}
impl HasResourceMeta for TestResource {}
impl HasIcons for TestResource {}

#[tokio::test]
async fn test_resources_list_pagination() {
    // Create handler with multiple resources
    let mut handler = ResourcesListHandler::new();

    // Add resources in predictable order (will be sorted by URI)
    for i in 1..=75 {
        let resource = TestResource::new(format!("item_{:03}", i));
        handler = handler.add_resource(resource);
    }

    // Test first page (no cursor)
    let page1_response = handler.handle(None).await.unwrap();
    let page1_data: PaginatedResponse<ListResourcesResult> =
        serde_json::from_value(page1_response).unwrap();

    // Validate first page
    assert_eq!(page1_data.data.resources.len(), 50); // Default page size
    assert!(page1_data.meta.is_some());

    let page1_meta = page1_data.meta.as_ref().unwrap();
    assert_eq!(page1_meta.total, Some(75));
    assert_eq!(page1_meta.has_more, Some(true));
    assert!(page1_meta.cursor.is_some());

    // Test second page using cursor
    let cursor = page1_meta.cursor.as_ref().unwrap();
    let page2_params = json!({ "cursor": cursor.as_str() });
    let page2_response = handler.handle(Some(page2_params)).await.unwrap();
    let page2_data: PaginatedResponse<ListResourcesResult> =
        serde_json::from_value(page2_response).unwrap();

    // Validate second page
    assert_eq!(page2_data.data.resources.len(), 25); // Remaining items
    assert!(page2_data.meta.is_some());

    let page2_meta = page2_data.meta.as_ref().unwrap();
    assert_eq!(page2_meta.total, Some(75));
    assert_eq!(page2_meta.has_more, Some(false)); // No more pages
    assert!(page2_meta.cursor.is_none()); // No next cursor

    // Verify no overlap between pages
    let page1_uris: Vec<&String> = page1_data.data.resources.iter().map(|r| &r.uri).collect();
    let page2_uris: Vec<&String> = page2_data.data.resources.iter().map(|r| &r.uri).collect();

    for page1_uri in &page1_uris {
        assert!(!page2_uris.contains(page1_uri), "Pages should not overlap");
    }
}

#[tokio::test]
async fn test_pagination_cursor_consistency() {
    // Test that cursors work consistently
    let mut handler = ResourcesListHandler::new();

    // Add fewer resources to test edge cases
    for i in 1..=10 {
        let resource = TestResource::new(format!("cursor_test_{:02}", i));
        handler = handler.add_resource(resource);
    }

    // All resources should fit in one page
    let response = handler.handle(None).await.unwrap();
    let data: PaginatedResponse<ListResourcesResult> = serde_json::from_value(response).unwrap();

    assert_eq!(data.data.resources.len(), 10);
    assert!(data.meta.is_some());

    let meta = data.meta.as_ref().unwrap();
    assert_eq!(meta.total, Some(10));
    assert_eq!(meta.has_more, Some(false)); // No more pages
    assert!(meta.cursor.is_none()); // No next cursor when all fit in one page
}

#[tokio::test]
async fn test_pagination_with_invalid_cursor() {
    // Test that invalid cursors are handled gracefully
    let mut handler = ResourcesListHandler::new();

    for i in 1..=5 {
        let resource = TestResource::new(format!("invalid_test_{}", i));
        handler = handler.add_resource(resource);
    }

    // Test with invalid cursor (should start from beginning)
    let invalid_params = json!({ "cursor": "invalid_cursor_value" });
    let response = handler.handle(Some(invalid_params)).await.unwrap();
    let data: PaginatedResponse<ListResourcesResult> = serde_json::from_value(response).unwrap();

    // Should return all resources (graceful fallback)
    assert_eq!(data.data.resources.len(), 5);
    assert!(data.meta.is_some());
    assert_eq!(data.meta.as_ref().unwrap().has_more, Some(false));
}

#[tokio::test]
async fn test_empty_resources_pagination() {
    // Test pagination with no resources
    let handler = ResourcesListHandler::new();

    let response = handler.handle(None).await.unwrap();
    let data: PaginatedResponse<ListResourcesResult> = serde_json::from_value(response).unwrap();

    // Empty list should have proper pagination metadata
    assert_eq!(data.data.resources.len(), 0);
    assert!(data.meta.is_some());

    let meta = data.meta.as_ref().unwrap();
    assert_eq!(meta.total, Some(0));
    assert_eq!(meta.has_more, Some(false));
    assert!(meta.cursor.is_none());
}

#[tokio::test]
async fn test_pagination_sorting_order_validation() {
    // Test that resources are actually sorted by URI as required by MCP spec
    let mut handler = ResourcesListHandler::new();

    // Add resources in deliberately unsorted order
    let test_uris = vec![
        "test://zebra/item",
        "test://alpha/item",
        "test://beta/item",
        "test://gamma/item",
        "test://delta/item",
    ];

    for uri in &test_uris {
        let resource = TestResource {
            id: uri.replace("test://", "").replace("/item", ""),
            uri: uri.to_string(),
        };
        handler = handler.add_resource(resource);
    }

    // Get all resources in one page
    let response = handler.handle(None).await.unwrap();
    let data: PaginatedResponse<ListResourcesResult> = serde_json::from_value(response).unwrap();

    // Extract URIs from response
    let returned_uris: Vec<&String> = data.data.resources.iter().map(|r| &r.uri).collect();

    // URIs should be sorted alphabetically
    let mut expected_uris = test_uris.clone();
    expected_uris.sort();

    assert_eq!(returned_uris.len(), expected_uris.len());
    for (returned, expected) in returned_uris.iter().zip(expected_uris.iter()) {
        assert_eq!(returned, expected, "Resources should be sorted by URI");
    }
}

#[tokio::test]
async fn test_pagination_cursor_robustness() {
    // Test cursor with special characters and edge cases
    let mut handler = ResourcesListHandler::new();

    // Add resources with special characters in URIs
    let special_uris = vec![
        "file:///test/item-001.json",
        "file:///test/item_002.json",
        "file:///test/item%20003.json",
        "file:///test/item+004.json",
        "file:///test/item@005.json",
    ];

    for uri in &special_uris {
        let resource = TestResource {
            id: uri.replace("file:///test/", "").replace(".json", ""),
            uri: uri.to_string(),
        };
        handler = handler.add_resource(resource);
    }

    // Get first page with small page size to force pagination
    // Since we can't change page size easily, add more resources to force pagination
    for i in 6..=55 {
        let resource = TestResource {
            id: format!("item_{:03}", i),
            uri: format!("file:///test/item_{:03}.json", i),
        };
        handler = handler.add_resource(resource);
    }

    // Get first page
    let page1_response = handler.handle(None).await.unwrap();
    let page1_data: PaginatedResponse<ListResourcesResult> =
        serde_json::from_value(page1_response).unwrap();

    assert!(page1_data.meta.as_ref().unwrap().cursor.is_some());
    let cursor = page1_data.meta.as_ref().unwrap().cursor.as_ref().unwrap();

    // Test cursor persistence - same cursor should return same results
    let page2_params = json!({ "cursor": cursor.as_str() });
    let page2_response1 = handler.handle(Some(page2_params.clone())).await.unwrap();
    let page2_response2 = handler.handle(Some(page2_params)).await.unwrap();

    // Should get identical results with same cursor
    assert_eq!(
        serde_json::to_string(&page2_response1).unwrap(),
        serde_json::to_string(&page2_response2).unwrap(),
        "Same cursor should return identical results"
    );
}

#[tokio::test]
async fn test_pagination_page_size_behavior() {
    // Test that the default page size (50) is actually respected
    let mut handler = ResourcesListHandler::new();

    // Add exactly 75 resources to test page boundaries
    for i in 1..=75 {
        let resource = TestResource::new(format!("pagesize_test_{:03}", i));
        handler = handler.add_resource(resource);
    }

    // First page should have exactly 50 resources
    let page1_response = handler.handle(None).await.unwrap();
    let page1_data: PaginatedResponse<ListResourcesResult> =
        serde_json::from_value(page1_response).unwrap();

    assert_eq!(
        page1_data.data.resources.len(),
        50,
        "First page should have 50 resources"
    );
    assert_eq!(page1_data.meta.as_ref().unwrap().has_more, Some(true));

    // Second page should have remaining 25 resources
    let cursor = page1_data.meta.as_ref().unwrap().cursor.as_ref().unwrap();
    let page2_params = json!({ "cursor": cursor.as_str() });
    let page2_response = handler.handle(Some(page2_params)).await.unwrap();
    let page2_data: PaginatedResponse<ListResourcesResult> =
        serde_json::from_value(page2_response).unwrap();

    assert_eq!(
        page2_data.data.resources.len(),
        25,
        "Second page should have 25 resources"
    );
    assert_eq!(page2_data.meta.as_ref().unwrap().has_more, Some(false));

    // Test with exactly 50 resources
    let mut handler_50 = ResourcesListHandler::new();
    for i in 1..=50 {
        let resource = TestResource::new(format!("exact_50_{:03}", i));
        handler_50 = handler_50.add_resource(resource);
    }

    let response_50 = handler_50.handle(None).await.unwrap();
    let data_50: PaginatedResponse<ListResourcesResult> =
        serde_json::from_value(response_50).unwrap();

    assert_eq!(
        data_50.data.resources.len(),
        50,
        "Should return all 50 resources in one page"
    );
    assert_eq!(
        data_50.meta.as_ref().unwrap().has_more,
        Some(false),
        "Should not have more pages"
    );
    assert!(
        data_50.meta.as_ref().unwrap().cursor.is_none(),
        "Should not have next cursor"
    );
}

#[tokio::test]
async fn test_pagination_resource_content_correctness() {
    // Verify actual resource URIs match expected values and appear in correct order
    let mut handler = ResourcesListHandler::new();

    // Add resources with predictable naming pattern
    let expected_ids = (1..=10)
        .map(|i| format!("content_test_{:02}", i))
        .collect::<Vec<_>>();
    let expected_uris = expected_ids
        .iter()
        .map(|id| format!("test://item/{}", id))
        .collect::<Vec<_>>();

    // Add in reverse order to test sorting
    for id in expected_ids.iter().rev() {
        let resource = TestResource {
            id: id.clone(),
            uri: format!("test://item/{}", id),
        };
        handler = handler.add_resource(resource);
    }

    let response = handler.handle(None).await.unwrap();
    let data: PaginatedResponse<ListResourcesResult> = serde_json::from_value(response).unwrap();

    // Verify all resources are present and correctly ordered
    assert_eq!(data.data.resources.len(), expected_uris.len());

    // Check each resource has correct URI and metadata
    for (i, resource) in data.data.resources.iter().enumerate() {
        assert_eq!(
            resource.uri, expected_uris[i],
            "Resource {} should have correct URI",
            i
        );
        assert_eq!(
            resource.name, "test_resource",
            "Resource should have correct name"
        );
        assert_eq!(
            resource.description,
            Some("Test resource for pagination".to_string())
        );
        assert_eq!(resource.mime_type, None); // TestResource returns None for mime_type
    }
}

#[tokio::test]
async fn test_pagination_boundary_conditions() {
    // Test edge cases: 0, 1, 49, 50, 51, 100, 101 resources
    let test_cases = vec![1, 49, 50, 51, 100, 101];

    for &resource_count in &test_cases {
        let mut handler = ResourcesListHandler::new();

        // Add specified number of resources
        for i in 1..=resource_count {
            let resource = TestResource::new(format!("boundary_test_{}_{:03}", resource_count, i));
            handler = handler.add_resource(resource);
        }

        // Get first page
        let page1_response = handler.handle(None).await.unwrap();
        let page1_data: PaginatedResponse<ListResourcesResult> =
            serde_json::from_value(page1_response).unwrap();

        let expected_page1_size = std::cmp::min(resource_count, 50);
        let expected_has_more = resource_count > 50;

        assert_eq!(
            page1_data.data.resources.len(),
            expected_page1_size,
            "First page size should be correct for {} resources",
            resource_count
        );

        assert_eq!(
            page1_data.meta.as_ref().unwrap().has_more,
            Some(expected_has_more),
            "has_more should be correct for {} resources",
            resource_count
        );

        assert_eq!(
            page1_data.meta.as_ref().unwrap().total,
            Some(resource_count as u64),
            "Total count should be correct for {} resources",
            resource_count
        );

        // Test cursor behavior
        if expected_has_more {
            assert!(
                page1_data.meta.as_ref().unwrap().cursor.is_some(),
                "Should have cursor when more pages exist for {} resources",
                resource_count
            );

            // Test second page
            let cursor = page1_data.meta.as_ref().unwrap().cursor.as_ref().unwrap();
            let page2_params = json!({ "cursor": cursor.as_str() });
            let page2_response = handler.handle(Some(page2_params)).await.unwrap();
            let page2_data: PaginatedResponse<ListResourcesResult> =
                serde_json::from_value(page2_response).unwrap();

            let remaining_resources = resource_count - 50;
            let expected_page2_size = std::cmp::min(remaining_resources, 50);
            let expected_page2_has_more = remaining_resources > 50;

            assert_eq!(
                page2_data.data.resources.len(),
                expected_page2_size,
                "Second page size should be correct for {} resources",
                resource_count
            );

            assert_eq!(
                page2_data.meta.as_ref().unwrap().has_more,
                Some(expected_page2_has_more),
                "Second page has_more should be correct for {} resources",
                resource_count
            );
        } else {
            assert!(
                page1_data.meta.as_ref().unwrap().cursor.is_none(),
                "Should not have cursor when no more pages for {} resources",
                resource_count
            );
        }
    }
}