solidmcp 0.4.0

A high-level Rust toolkit for building Model Context Protocol (MCP) servers with type safety and minimal boilerplate. Supports tools, resources, and prompts with automatic JSON schema generation.
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
529
530
531
532
533
534
535
//! Caching and Invalidation Behavior Tests
//!
//! Tests for prompt system consistency, state management, and behavior
//! that would be relevant for caching implementations.

use serde_json::{json, Value};
use std::time::Duration;
use tokio_tungstenite::tungstenite::Message;
use futures_util::{SinkExt, StreamExt};
use anyhow::Result;
use std::sync::Arc;
use async_trait::async_trait;
use solidmcp::framework::{McpServerBuilder, PromptProvider};
use solidmcp::handler::{PromptInfo, PromptContent, PromptMessage, PromptArgument};

mod mcp_test_helpers;
use mcp_test_helpers::*;

/// Test context for caching behavior tests
#[derive(Clone)]
pub struct CachingTestContext {
    pub server_name: String,
    pub call_count: Arc<std::sync::atomic::AtomicUsize>,
    pub dynamic_content: Arc<std::sync::Mutex<String>>,
}

/// Caching-aware prompt provider that tracks calls and state
pub struct CachingPromptProvider;

#[async_trait]
impl PromptProvider<CachingTestContext> for CachingPromptProvider {
    async fn list_prompts(&self, context: Arc<CachingTestContext>) -> Result<Vec<PromptInfo>> {
        // Increment call counter
        context.call_count.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
        
        Ok(vec![
            PromptInfo {
                name: "static_prompt".to_string(),
                description: Some("A static prompt that should be cacheable".to_string()),
                arguments: vec![
                    PromptArgument {
                        name: "input".to_string(),
                        description: Some("Input parameter".to_string()),
                        required: true,
                    },
                ],
            },
            PromptInfo {
                name: "dynamic_prompt".to_string(),
                description: Some("A dynamic prompt with changing content".to_string()),
                arguments: vec![
                    PromptArgument {
                        name: "refresh".to_string(),
                        description: Some("Whether to refresh content".to_string()),
                        required: false,
                    },
                ],
            },
            PromptInfo {
                name: "timestamp_prompt".to_string(),
                description: Some("A prompt that includes timestamps".to_string()),
                arguments: vec![
                    PromptArgument {
                        name: "include_time".to_string(),
                        description: Some("Whether to include current time".to_string()),
                        required: false,
                    },
                ],
            },
        ])
    }

    async fn get_prompt(&self, name: &str, arguments: Option<Value>, context: Arc<CachingTestContext>) -> Result<PromptContent> {
        // Increment call counter
        context.call_count.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
        
        let default_map = serde_json::Map::new();
        let args = arguments.as_ref().and_then(|v| v.as_object()).unwrap_or(&default_map);

        match name {
            "static_prompt" => {
                let input = args.get("input")
                    .and_then(|v| v.as_str())
                    .ok_or_else(|| anyhow::anyhow!("Missing required argument: input"))?;

                // This should be cacheable - same input always produces same output
                Ok(PromptContent {
                    messages: vec![
                        PromptMessage {
                            role: "system".to_string(),
                            content: "You are processing static content that should be cacheable.".to_string(),
                        },
                        PromptMessage {
                            role: "user".to_string(),
                            content: format!("Process this static input: {}", input),
                        },
                    ],
                })
            }
            "dynamic_prompt" => {
                let refresh = args.get("refresh")
                    .and_then(|v| v.as_bool())
                    .unwrap_or(false);

                let content = if refresh {
                    // Update dynamic content
                    let new_content = format!("Updated content at call #{}", 
                        context.call_count.load(std::sync::atomic::Ordering::SeqCst));
                    if let Ok(mut dynamic) = context.dynamic_content.lock() {
                        *dynamic = new_content.clone();
                    }
                    new_content
                } else {
                    // Use existing dynamic content
                    context.dynamic_content.lock()
                        .map(|content| content.clone())
                        .unwrap_or_else(|_| "Default dynamic content".to_string())
                };

                Ok(PromptContent {
                    messages: vec![
                        PromptMessage {
                            role: "system".to_string(),
                            content: "You are processing dynamic content that changes over time.".to_string(),
                        },
                        PromptMessage {
                            role: "user".to_string(),
                            content: format!("Dynamic content: {}", content),
                        },
                    ],
                })
            }
            "timestamp_prompt" => {
                let include_time = args.get("include_time")
                    .and_then(|v| v.as_bool())
                    .unwrap_or(false);

                let content = if include_time {
                    // Use nanoseconds for more precision and add call count for uniqueness
                    let nanos = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_nanos();
                    let call_num = context.call_count.load(std::sync::atomic::Ordering::SeqCst);
                    format!("Current timestamp: {} (call {})", nanos, call_num)
                } else {
                    "Timeless content".to_string()
                };

                Ok(PromptContent {
                    messages: vec![
                        PromptMessage {
                            role: "system".to_string(),
                            content: "You are processing content that may include timestamps.".to_string(),
                        },
                        PromptMessage {
                            role: "user".to_string(),
                            content,
                        },
                    ],
                })
            }
            _ => Err(anyhow::anyhow!("Prompt not found: {}", name))
        }
    }
}

/// Helper to create caching test server
async fn create_caching_test_server() -> Result<(solidmcp::McpServer, Arc<CachingTestContext>), Box<dyn std::error::Error + Send + Sync>> {
    let context = CachingTestContext {
        server_name: "caching-test-server".to_string(),
        call_count: Arc::new(std::sync::atomic::AtomicUsize::new(0)),
        dynamic_content: Arc::new(std::sync::Mutex::new("Initial dynamic content".to_string())),
    };

    let context_arc = Arc::new(context.clone());

    let server = McpServerBuilder::new(context, "caching-test-server", "1.0.0")
        .with_prompt_provider(Box::new(CachingPromptProvider))
        .build()
        .await?;

    Ok((server, context_arc))
}

/// Test consistent behavior for static prompts (cacheable scenarios)
#[tokio::test]
async fn test_static_prompt_consistency() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    init_test_tracing();

    let port = find_available_port().await?;
    let (server, context) = create_caching_test_server().await?;
    let server_handle = tokio::spawn(async move {
        let mut server = server;
        if let Err(e) = server.start(port).await {
            eprintln!("Test server error: {e}");
        }
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    // Make multiple requests with same parameters
    let ws_url = format!("ws://127.0.0.1:{}/mcp", port);
    let mut responses = Vec::new();

    for i in 0..3 {
        let (ws_stream, _) = tokio_tungstenite::connect_async(&ws_url).await?;
        let (mut write, mut read) = ws_stream.split();

        // Initialize connection
        let init_message = json!({
            "jsonrpc": "2.0",
            "id": 1,
            "method": "initialize",
            "params": {
                "protocolVersion": "2025-06-18",
                "capabilities": {},
                "clientInfo": {"name": format!("test-client-{}", i), "version": "1.0.0"}
            }
        });

        write.send(Message::Text(serde_json::to_string(&init_message)?.into())).await?;
        let _init_response = receive_ws_message(&mut read, Duration::from_secs(5)).await?;

        // Request same static prompt
        let get_message = json!({
            "jsonrpc": "2.0",
            "id": 2,
            "method": "prompts/get",
            "params": {
                "name": "static_prompt",
                "arguments": {
                    "input": "test_data"
                }
            }
        });

        write.send(Message::Text(serde_json::to_string(&get_message)?.into())).await?;
        let response_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
        let response: Value = serde_json::from_str(&response_text)?;

        responses.push(response);
    }

    // Verify all responses are identical (cacheable behavior)
    for i in 1..responses.len() {
        assert_eq!(responses[0]["result"]["messages"], responses[i]["result"]["messages"]);
    }

    // Verify call count increased (showing provider was called)
    let final_count = context.call_count.load(std::sync::atomic::Ordering::SeqCst);
    assert!(final_count >= 3); // At least one list_prompts + 3 get_prompt calls

    server_handle.abort();
    Ok(())
}

/// Test dynamic content behavior (cache invalidation scenarios)
#[tokio::test]
async fn test_dynamic_content_changes() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    init_test_tracing();

    let port = find_available_port().await?;
    let (server, _context) = create_caching_test_server().await?;
    let server_handle = tokio::spawn(async move {
        let mut server = server;
        if let Err(e) = server.start(port).await {
            eprintln!("Test server error: {e}");
        }
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    let ws_url = format!("ws://127.0.0.1:{}/mcp", port);
    let (ws_stream, _) = tokio_tungstenite::connect_async(&ws_url).await?;
    let (mut write, mut read) = ws_stream.split();

    // Initialize connection
    let init_message = json!({
        "jsonrpc": "2.0",
        "id": 1,
        "method": "initialize",
        "params": {
            "protocolVersion": "2025-06-18",
            "capabilities": {},
            "clientInfo": {"name": "test-client", "version": "1.0.0"}
        }
    });

    write.send(Message::Text(serde_json::to_string(&init_message)?.into())).await?;
    let _init_response = receive_ws_message(&mut read, Duration::from_secs(5)).await?;

    // First request without refresh
    let get_message1 = json!({
        "jsonrpc": "2.0",
        "id": 2,
        "method": "prompts/get",
        "params": {
            "name": "dynamic_prompt",
            "arguments": {
                "refresh": false
            }
        }
    });

    write.send(Message::Text(serde_json::to_string(&get_message1)?.into())).await?;
    let response1_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
    let response1: Value = serde_json::from_str(&response1_text)?;

    // Second request with refresh (should update content)
    let get_message2 = json!({
        "jsonrpc": "2.0",
        "id": 3,
        "method": "prompts/get",
        "params": {
            "name": "dynamic_prompt",
            "arguments": {
                "refresh": true
            }
        }
    });

    write.send(Message::Text(serde_json::to_string(&get_message2)?.into())).await?;
    let response2_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
    let response2: Value = serde_json::from_str(&response2_text)?;

    // Third request without refresh (should use updated content)
    let get_message3 = json!({
        "jsonrpc": "2.0",
        "id": 4,
        "method": "prompts/get",
        "params": {
            "name": "dynamic_prompt",
            "arguments": {
                "refresh": false
            }
        }
    });

    write.send(Message::Text(serde_json::to_string(&get_message3)?.into())).await?;
    let response3_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
    let response3: Value = serde_json::from_str(&response3_text)?;

    // Verify content changed after refresh
    let content1 = response1["result"]["messages"][1]["content"]["text"].as_str().unwrap();
    let content2 = response2["result"]["messages"][1]["content"]["text"].as_str().unwrap();
    let content3 = response3["result"]["messages"][1]["content"]["text"].as_str().unwrap();

    assert_ne!(content1, content2); // Content should change after refresh
    assert_eq!(content2, content3); // Content should remain same after update

    server_handle.abort();
    Ok(())
}

/// Test timestamp-based invalidation scenarios
#[tokio::test]
async fn test_timestamp_based_content() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    init_test_tracing();

    let port = find_available_port().await?;
    let (server, _context) = create_caching_test_server().await?;
    let server_handle = tokio::spawn(async move {
        let mut server = server;
        if let Err(e) = server.start(port).await {
            eprintln!("Test server error: {e}");
        }
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    let ws_url = format!("ws://127.0.0.1:{}/mcp", port);
    let (ws_stream, _) = tokio_tungstenite::connect_async(&ws_url).await?;
    let (mut write, mut read) = ws_stream.split();

    // Initialize connection
    let init_message = json!({
        "jsonrpc": "2.0",
        "id": 1,
        "method": "initialize",
        "params": {
            "protocolVersion": "2025-06-18",
            "capabilities": {},
            "clientInfo": {"name": "test-client", "version": "1.0.0"}
        }
    });

    write.send(Message::Text(serde_json::to_string(&init_message)?.into())).await?;
    let _init_response = receive_ws_message(&mut read, Duration::from_secs(5)).await?;

    // Request without timestamp
    let get_message1 = json!({
        "jsonrpc": "2.0",
        "id": 2,
        "method": "prompts/get",
        "params": {
            "name": "timestamp_prompt",
            "arguments": {
                "include_time": false
            }
        }
    });

    write.send(Message::Text(serde_json::to_string(&get_message1)?.into())).await?;
    let response1_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
    let response1: Value = serde_json::from_str(&response1_text)?;

    // Wait a moment
    tokio::time::sleep(Duration::from_millis(50)).await;

    // Request with timestamp (first time)
    let get_message2 = json!({
        "jsonrpc": "2.0",
        "id": 3,
        "method": "prompts/get",
        "params": {
            "name": "timestamp_prompt",
            "arguments": {
                "include_time": true
            }
        }
    });

    write.send(Message::Text(serde_json::to_string(&get_message2)?.into())).await?;
    let response2_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
    let response2: Value = serde_json::from_str(&response2_text)?;

    // Wait a moment
    tokio::time::sleep(Duration::from_millis(50)).await;

    // Request with timestamp (second time)
    let get_message3 = json!({
        "jsonrpc": "2.0",
        "id": 4,
        "method": "prompts/get",
        "params": {
            "name": "timestamp_prompt",
            "arguments": {
                "include_time": true
            }
        }
    });

    write.send(Message::Text(serde_json::to_string(&get_message3)?.into())).await?;
    let response3_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
    let response3: Value = serde_json::from_str(&response3_text)?;

    // Verify behavior
    let content1 = response1["result"]["messages"][1]["content"]["text"].as_str().unwrap();
    let content2 = response2["result"]["messages"][1]["content"]["text"].as_str().unwrap();
    let content3 = response3["result"]["messages"][1]["content"]["text"].as_str().unwrap();

    assert_eq!(content1, "Timeless content"); // Static content without time
    assert!(content2.contains("Current timestamp:")); // Should contain timestamp
    assert!(content3.contains("Current timestamp:")); // Should contain timestamp
    assert_ne!(content2, content3); // Timestamps should be different

    server_handle.abort();
    Ok(())
}

/// Test prompt list consistency behavior
#[tokio::test]
async fn test_prompt_list_consistency() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    init_test_tracing();

    let port = find_available_port().await?;
    let (server, context) = create_caching_test_server().await?;
    let server_handle = tokio::spawn(async move {
        let mut server = server;
        if let Err(e) = server.start(port).await {
            eprintln!("Test server error: {e}");
        }
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    let ws_url = format!("ws://127.0.0.1:{}/mcp", port);

    // Make multiple list requests from different connections
    let mut list_responses = Vec::new();
    for i in 0..3 {
        let (ws_stream, _) = tokio_tungstenite::connect_async(&ws_url).await?;
        let (mut write, mut read) = ws_stream.split();

        // Initialize connection
        let init_message = json!({
            "jsonrpc": "2.0",
            "id": 1,
            "method": "initialize",
            "params": {
                "protocolVersion": "2025-06-18",
                "capabilities": {},
                "clientInfo": {"name": format!("list-client-{}", i), "version": "1.0.0"}
            }
        });

        write.send(Message::Text(serde_json::to_string(&init_message)?.into())).await?;
        let _init_response = receive_ws_message(&mut read, Duration::from_secs(5)).await?;

        // Request prompt list
        let list_message = json!({
            "jsonrpc": "2.0",
            "id": 2,
            "method": "prompts/list",
            "params": {}
        });

        write.send(Message::Text(serde_json::to_string(&list_message)?.into())).await?;
        let response_text = receive_ws_message(&mut read, Duration::from_secs(5)).await?;
        let response: Value = serde_json::from_str(&response_text)?;

        list_responses.push(response);
    }

    // Verify all list responses are identical (consistent behavior)
    for i in 1..list_responses.len() {
        assert_eq!(list_responses[0]["result"]["prompts"], list_responses[i]["result"]["prompts"]);
    }

    // Verify the list contains expected prompts
    let prompts = list_responses[0]["result"]["prompts"].as_array().unwrap();
    assert_eq!(prompts.len(), 3);

    let prompt_names: Vec<&str> = prompts.iter()
        .map(|p| p["name"].as_str().unwrap())
        .collect();
    assert!(prompt_names.contains(&"static_prompt"));
    assert!(prompt_names.contains(&"dynamic_prompt"));
    assert!(prompt_names.contains(&"timestamp_prompt"));

    // Verify call count shows list_prompts was called multiple times
    let final_count = context.call_count.load(std::sync::atomic::Ordering::SeqCst);
    assert!(final_count >= 3); // Should have been called at least 3 times

    server_handle.abort();
    Ok(())
}