contextvm-sdk 0.1.1

Rust SDK for the ContextVM protocol — MCP over Nostr
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
//! End-to-end happy path integration tests.
//!
//! Exercises the full SDK stack in-memory: RMCP handler → NostrServerWorker →
//! NostrServerTransport → MockRelayPool → NostrClientTransport →
//! NostrClientWorker → RMCP client.  No network required.

#![cfg(feature = "rmcp")]

use std::sync::Arc;
use std::time::Duration;

use contextvm_sdk::core::types::EncryptionMode;
use contextvm_sdk::relay::mock::MockRelayPool;
use contextvm_sdk::transport::client::{NostrClientTransport, NostrClientTransportConfig};
use contextvm_sdk::transport::server::{NostrServerTransport, NostrServerTransportConfig};
use contextvm_sdk::RelayPoolTrait;

use rmcp::{
    handler::server::router::tool::ToolRouter, handler::server::wrapper::Parameters, model::*,
    schemars, service::RequestContext, tool, tool_handler, tool_router, ClientHandler, RoleServer,
    ServerHandler, ServiceExt,
};
use tokio::sync::Mutex;

// ── Fixtures ──────────────────────────────────────────────────────────────

#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct EchoParams {
    message: String,
}

#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddParams {
    a: i64,
    b: i64,
}

#[derive(Clone)]
struct DemoServer {
    echo_count: Arc<Mutex<u32>>,
    tool_router: ToolRouter<DemoServer>,
}

impl DemoServer {
    fn new() -> Self {
        Self {
            echo_count: Arc::new(Mutex::new(0)),
            tool_router: Self::tool_router(),
        }
    }
}

#[tool_router]
impl DemoServer {
    #[tool(description = "Echo a message back")]
    async fn echo(
        &self,
        Parameters(EchoParams { message }): Parameters<EchoParams>,
    ) -> Result<CallToolResult, ErrorData> {
        let mut n = self.echo_count.lock().await;
        *n += 1;
        Ok(CallToolResult::success(vec![Content::text(format!(
            "Echo #{n}: {message}"
        ))]))
    }

    #[tool(description = "Add two integers")]
    fn add(
        &self,
        Parameters(AddParams { a, b }): Parameters<AddParams>,
    ) -> Result<CallToolResult, ErrorData> {
        Ok(CallToolResult::success(vec![Content::text(format!(
            "{a} + {b} = {}",
            a + b
        ))]))
    }

    #[tool(description = "Return total echo calls")]
    async fn get_echo_count(&self) -> Result<CallToolResult, ErrorData> {
        let n = self.echo_count.lock().await;
        Ok(CallToolResult::success(vec![Content::text(format!(
            "Total echo calls: {n}"
        ))]))
    }
}

#[tool_handler]
impl ServerHandler for DemoServer {
    fn get_info(&self) -> ServerInfo {
        ServerInfo {
            protocol_version: ProtocolVersion::LATEST,
            capabilities: ServerCapabilities::builder()
                .enable_tools()
                .enable_resources()
                .build(),
            server_info: Implementation {
                name: "e2e-test-server".to_string(),
                title: None,
                version: "0.1.0".to_string(),
                description: None,
                icons: None,
                website_url: None,
            },
            instructions: None,
        }
    }

    async fn list_resources(
        &self,
        _req: Option<PaginatedRequestParams>,
        _ctx: RequestContext<RoleServer>,
    ) -> Result<ListResourcesResult, ErrorData> {
        Ok(ListResourcesResult {
            resources: vec![
                RawResource::new("demo://readme", "Demo README".to_string()).no_annotation()
            ],
            next_cursor: None,
            meta: None,
        })
    }

    async fn read_resource(
        &self,
        req: ReadResourceRequestParams,
        _ctx: RequestContext<RoleServer>,
    ) -> Result<ReadResourceResult, ErrorData> {
        match req.uri.as_str() {
            "demo://readme" => Ok(ReadResourceResult {
                contents: vec![ResourceContents::text("Demo content.", req.uri)],
            }),
            other => Err(ErrorData::resource_not_found(
                "not_found",
                Some(serde_json::json!({ "uri": other })),
            )),
        }
    }
}

#[derive(Clone, Default)]
struct DemoClient;
impl ClientHandler for DemoClient {}

// ── Helpers ───────────────────────────────────────────────────────────────

fn as_pool(pool: MockRelayPool) -> Arc<dyn RelayPoolTrait> {
    Arc::new(pool)
}

fn first_text(result: &CallToolResult) -> String {
    result
        .content
        .iter()
        .find_map(|c| match &c.raw {
            RawContent::Text(t) => Some(t.text.clone()),
            _ => None,
        })
        .unwrap_or_default()
}

fn call_params(name: &'static str, args: Option<serde_json::Value>) -> CallToolRequestParams {
    CallToolRequestParams {
        name: name.into(),
        arguments: args.and_then(|v| serde_json::from_value(v).ok()),
        meta: None,
        task: None,
    }
}

// ── Core scenario runner ──────────────────────────────────────────────────

async fn run_e2e_scenario(mode: EncryptionMode) {
    let (client_pool, server_pool) = MockRelayPool::create_pair();

    // Extract server pubkey before as_pool() takes ownership
    let server_pubkey_hex = server_pool.mock_public_key().to_hex();

    let server_transport = NostrServerTransport::with_relay_pool(
        NostrServerTransportConfig::default().with_encryption_mode(mode),
        as_pool(server_pool),
    )
    .await
    .expect("create server transport");

    let client_transport = NostrClientTransport::with_relay_pool(
        NostrClientTransportConfig::default()
            .with_server_pubkey(server_pubkey_hex)
            .with_encryption_mode(mode),
        as_pool(client_pool),
    )
    .await
    .expect("create client transport");

    let server_handle = tokio::spawn(async move {
        DemoServer::new()
            .serve(server_transport)
            .await
            .expect("server serve failed")
            .waiting()
            .await
            .expect("server error");
    });

    // Let server event loop establish subscriptions
    tokio::time::sleep(Duration::from_millis(10)).await;

    // rmcp handles the initialize handshake
    let client = tokio::time::timeout(Duration::from_secs(5), DemoClient.serve(client_transport))
        .await
        .expect("client startup timed out")
        .expect("client init failed");

    let peer = client
        .peer_info()
        .expect("peer_info should be available after serve()");
    assert_eq!(
        peer.server_info.name, "e2e-test-server",
        "server name mismatch"
    );

    let tools = client.list_all_tools().await.expect("list_all_tools");
    assert_eq!(tools.len(), 3, "expected 3 tools");
    let tool_names: Vec<&str> = tools.iter().map(|t| t.name.as_ref()).collect();
    assert!(tool_names.contains(&"echo"), "missing echo tool");
    assert!(tool_names.contains(&"add"), "missing add tool");
    assert!(
        tool_names.contains(&"get_echo_count"),
        "missing get_echo_count tool"
    );

    let echo1 = client
        .call_tool(call_params(
            "echo",
            Some(serde_json::json!({"message": "hello"})),
        ))
        .await
        .expect("echo call");
    let echo1_text = first_text(&echo1);
    assert!(
        echo1_text.contains("hello"),
        "echo should contain 'hello', got: {echo1_text}"
    );
    assert!(
        echo1_text.contains("#1"),
        "first echo should be #1, got: {echo1_text}"
    );

    let add = client
        .call_tool(call_params(
            "add",
            Some(serde_json::json!({"a": 7, "b": 5})),
        ))
        .await
        .expect("add call");
    let add_text = first_text(&add);
    assert!(
        add_text.contains("12"),
        "add result should contain 12, got: {add_text}"
    );

    let count = client
        .call_tool(call_params("get_echo_count", None))
        .await
        .expect("get_echo_count call");
    let count_text = first_text(&count);
    assert!(
        count_text.contains("calls: 1"),
        "echo count should be 1 after one echo call, got: {count_text}"
    );

    let echo2 = client
        .call_tool(call_params(
            "echo",
            Some(serde_json::json!({"message": "world"})),
        ))
        .await
        .expect("second echo call");
    let echo2_text = first_text(&echo2);
    assert!(
        echo2_text.contains("#2"),
        "second echo should be #2, got: {echo2_text}"
    );

    let count2 = client
        .call_tool(call_params("get_echo_count", None))
        .await
        .expect("get_echo_count after second echo");
    let count2_text = first_text(&count2);
    assert!(
        count2_text.contains("calls: 2"),
        "echo count should be 2, got: {count2_text}"
    );

    let resources = client
        .list_all_resources()
        .await
        .expect("list_all_resources");
    assert_eq!(resources.len(), 1, "expected 1 resource");
    assert_eq!(resources[0].uri.as_str(), "demo://readme");
    assert_eq!(resources[0].name.as_str(), "Demo README");

    let read_result = client
        .read_resource(ReadResourceRequestParams {
            uri: "demo://readme".to_string(),
            meta: None,
        })
        .await
        .expect("read_resource");
    assert_eq!(read_result.contents.len(), 1);
    match &read_result.contents[0] {
        ResourceContents::TextResourceContents { text, uri, .. } => {
            assert_eq!(uri, "demo://readme");
            assert!(
                text.contains("Demo content."),
                "unexpected resource text: {text}"
            );
        }
        _ => panic!("expected TextResourceContents"),
    }

    match client.call_tool(call_params("no_such_tool", None)).await {
        Err(_) => {}
        Ok(r) if r.is_error.unwrap_or(false) => {}
        Ok(_) => panic!("expected unknown tool to fail"),
    }

    client.cancel().await.expect("client cancel");
    server_handle.abort();
}

// ── Tests ─────────────────────────────────────────────────────────────────

// NOTE: EncryptionMode::Disabled is intentionally NOT tested here.
// MockRelayPool broadcasts all events to all receivers, including the publisher.
// In Disabled mode (plaintext kind 25910), the server receives its own responses
// and the RMCP handler rejects them. In encrypted modes, the server naturally
// can't decrypt events gift-wrapped for the client, so they're filtered out.
// Real Nostr relays do not echo events back to the publisher, so this is a
// mock-only limitation. Disabled mode is tested at the transport level in
// tests/transport_integration.rs.

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn e2e_happy_path_encryption_optional() {
    run_e2e_scenario(EncryptionMode::Optional).await;
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn e2e_happy_path_encryption_required() {
    run_e2e_scenario(EncryptionMode::Required).await;
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn e2e_multi_client_no_crosstalk() {
    let mut pools = MockRelayPool::create_linked_group(3);
    let server_pool = pools.remove(0);
    let client1_pool = pools.remove(0);
    let client2_pool = pools.remove(0);

    // Extract server pubkey BEFORE as_pool() takes ownership
    let server_pubkey_hex = server_pool.mock_public_key().to_hex();

    let server_transport = NostrServerTransport::with_relay_pool(
        NostrServerTransportConfig::default().with_encryption_mode(EncryptionMode::Optional),
        as_pool(server_pool),
    )
    .await
    .expect("create server transport");

    let server_handle = tokio::spawn(async move {
        DemoServer::new()
            .serve(server_transport)
            .await
            .expect("server serve failed")
            .waiting()
            .await
            .expect("server error");
    });

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

    // Create two independent clients
    let client1_transport = NostrClientTransport::with_relay_pool(
        NostrClientTransportConfig::default()
            .with_server_pubkey(server_pubkey_hex.clone())
            .with_encryption_mode(EncryptionMode::Optional),
        as_pool(client1_pool),
    )
    .await
    .expect("create client1 transport");

    let client2_transport = NostrClientTransport::with_relay_pool(
        NostrClientTransportConfig::default()
            .with_server_pubkey(server_pubkey_hex)
            .with_encryption_mode(EncryptionMode::Optional),
        as_pool(client2_pool),
    )
    .await
    .expect("create client2 transport");

    let client1 = tokio::time::timeout(Duration::from_secs(5), DemoClient.serve(client1_transport))
        .await
        .expect("client1 timed out")
        .expect("client1 init");

    let client2 = tokio::time::timeout(Duration::from_secs(5), DemoClient.serve(client2_transport))
        .await
        .expect("client2 timed out")
        .expect("client2 init");

    // Both clients call echo — responses must route correctly
    let r1 = client1
        .call_tool(call_params(
            "echo",
            Some(serde_json::json!({"message": "from-client1"})),
        ))
        .await
        .expect("client1 echo");
    assert!(
        first_text(&r1).contains("from-client1"),
        "client1 should get its own response"
    );

    let r2 = client2
        .call_tool(call_params(
            "echo",
            Some(serde_json::json!({"message": "from-client2"})),
        ))
        .await
        .expect("client2 echo");
    assert!(
        first_text(&r2).contains("from-client2"),
        "client2 should get its own response"
    );

    // Shared stateful counter should reflect calls from both clients
    let count = client1
        .call_tool(call_params("get_echo_count", None))
        .await
        .expect("client1 get_echo_count");
    assert!(
        first_text(&count).contains("calls: 2"),
        "echo count should be 2 after calls from both clients"
    );

    // Cleanup
    client1.cancel().await.expect("client1 cancel");
    client2.cancel().await.expect("client2 cancel");
    server_handle.abort();
}