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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
//! Conformance tests for ContextVM wire format: MCP JSON-RPC carried in Nostr kind 25910 events.
//!
//! These mirror the layering style of `src/rmcp_transport/pipeline_tests.rs`: build the JSON-RPC
//! payload, serialize through the same helpers the transport uses (`mcp_to_nostr_event`, tag
//! builders from [`BaseTransport`]), sign with nostr-sdk, then assert on kind, tags, and content.

use contextvm_sdk::core::constants::{
    mcp_protocol_version, tags, CTXVM_MESSAGES_KIND, INITIALIZE_METHOD,
    NOTIFICATIONS_INITIALIZED_METHOD, SERVER_ANNOUNCEMENT_KIND,
};
use contextvm_sdk::core::serializers;
use contextvm_sdk::core::types::{
    JsonRpcMessage, JsonRpcNotification, JsonRpcRequest, JsonRpcResponse,
};
use contextvm_sdk::transport::base::BaseTransport;
use nostr_sdk::prelude::*;

fn assert_ctxvm_message_kind(event: &Event) {
    assert_eq!(
        event.kind,
        Kind::Custom(CTXVM_MESSAGES_KIND),
        "ContextVM MCP messages must use kind {}",
        CTXVM_MESSAGES_KIND
    );
}

fn p_tag_hex(event: &Event) -> Option<String> {
    serializers::get_tag_value(&event.tags, tags::PUBKEY)
}

fn e_tag_hex(event: &Event) -> Option<String> {
    serializers::get_tag_value(&event.tags, tags::EVENT_ID)
}

// ── Initialize request ───────────────────────────────────────────────────────

#[test]
fn ctxvm_initialize_request_has_kind_p_tag_and_jsonrpc_initialize() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();

    let init_req = JsonRpcMessage::Request(JsonRpcRequest {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!(1),
        method: INITIALIZE_METHOD.to_string(),
        params: Some(serde_json::json!({
            "protocolVersion": mcp_protocol_version(),
            "capabilities": {},
            "clientInfo": { "name": "conformance-test", "version": "0.0.0" }
        })),
    });

    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let builder = serializers::mcp_to_nostr_event(&init_req, CTXVM_MESSAGES_KIND, recipient_tags)
        .expect("initialize request should serialize to event content");

    let client_keys = Keys::generate();
    let event = builder
        .sign_with_keys(&client_keys)
        .expect("sign initialize request event");

    assert_ctxvm_message_kind(&event);
    assert_eq!(
        p_tag_hex(&event),
        Some(server_pk.to_hex()),
        "initialize request must target the server via p tag"
    );

    let msg = serializers::nostr_event_to_mcp_message(&event.content)
        .expect("event content should be valid JSON-RPC");
    assert!(msg.is_request());
    assert_eq!(msg.method(), Some(INITIALIZE_METHOD));

    // Parse at the raw JSON level to verify wire format independently of the typed deserializer.
    let v: serde_json::Value =
        serde_json::from_str(&event.content).expect("content must be JSON object");
    assert_eq!(v["jsonrpc"], "2.0");
    assert_eq!(v["id"], serde_json::json!(1));
}

// ── Initialize response ──────────────────────────────────────────────────────

#[test]
fn ctxvm_initialize_response_has_kind_e_tag_and_result_protocol_version() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();
    let client_keys = Keys::generate();
    let client_pk = client_keys.public_key();

    // Signed request event provides the Nostr event id referenced by e on the response.
    let init_req = JsonRpcMessage::Request(JsonRpcRequest {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!("corr-1"),
        method: INITIALIZE_METHOD.to_string(),
        params: Some(serde_json::json!({})),
    });
    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let request_event =
        serializers::mcp_to_nostr_event(&init_req, CTXVM_MESSAGES_KIND, recipient_tags)
            .expect("request event for response correlation should serialize")
            .sign_with_keys(&client_keys)
            .expect("sign request event for correlation");

    let init_resp = JsonRpcMessage::Response(JsonRpcResponse {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!("corr-1"),
        result: serde_json::json!({
            "protocolVersion": mcp_protocol_version(),
            "serverInfo": {
                "name": "conformance-test-server",
                "version": "0.0.0"
            },
            "capabilities": {}
        }),
    });

    let response_tags = BaseTransport::create_response_tags(&client_pk, &request_event.id);
    let response_event =
        serializers::mcp_to_nostr_event(&init_resp, CTXVM_MESSAGES_KIND, response_tags)
            .expect("initialize response should serialize")
            .sign_with_keys(&server_keys)
            .expect("sign initialize response event");

    assert_ctxvm_message_kind(&response_event);
    assert_eq!(
        p_tag_hex(&response_event),
        Some(client_pk.to_hex()),
        "initialize response must route back to the client via p tag"
    );
    assert_eq!(
        e_tag_hex(&response_event),
        Some(request_event.id.to_hex()),
        "initialize response must correlate to the request Nostr event via e tag"
    );

    let v: serde_json::Value =
        serde_json::from_str(&response_event.content).expect("content must be JSON");
    assert_eq!(v["jsonrpc"], "2.0");
    assert_eq!(v["id"], serde_json::json!("corr-1"));
    assert!(v["result"]["protocolVersion"].is_string());
    assert!(v["result"]["serverInfo"]["name"].is_string());
}

// ── notifications/initialized ──────────────────────────────────────────────

#[test]
fn ctxvm_notifications_initialized_has_kind_p_tag_and_method() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();
    let client_keys = Keys::generate();

    let notif = JsonRpcMessage::Notification(JsonRpcNotification {
        jsonrpc: "2.0".to_string(),
        method: NOTIFICATIONS_INITIALIZED_METHOD.to_string(),
        params: None,
    });

    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let event = serializers::mcp_to_nostr_event(&notif, CTXVM_MESSAGES_KIND, recipient_tags)
        .expect("notification should serialize")
        // Client sends this to the server; signer must differ from `p` so the tag is not stripped.
        .sign_with_keys(&client_keys)
        .expect("sign initialized notification");

    assert_ctxvm_message_kind(&event);
    assert_eq!(
        p_tag_hex(&event),
        Some(server_pk.to_hex()),
        "initialized notification must include server p tag"
    );

    let msg = serializers::nostr_event_to_mcp_message(&event.content).expect("parse content");
    assert!(msg.is_notification());
    assert_eq!(msg.method(), Some(NOTIFICATIONS_INITIALIZED_METHOD));

    // Parse at the raw JSON level to verify wire format independently of the typed deserializer.
    let v: serde_json::Value =
        serde_json::from_str(&event.content).expect("content must be JSON object");
    assert_eq!(v["jsonrpc"], "2.0");
    assert!(
        v.get("id").is_none_or(serde_json::Value::is_null),
        "JSON-RPC notifications must not include an id"
    );
}

// ── tools/list request ───────────────────────────────────────────────────────

#[test]
fn ctxvm_tools_list_request_has_kind_p_tag_and_method() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();

    let list_req = JsonRpcMessage::Request(JsonRpcRequest {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!(2),
        method: "tools/list".to_string(),
        params: Some(serde_json::json!({})),
    });

    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let builder = serializers::mcp_to_nostr_event(&list_req, CTXVM_MESSAGES_KIND, recipient_tags)
        .expect("tools/list request should serialize to event content");

    let client_keys = Keys::generate();
    let event = builder
        .sign_with_keys(&client_keys)
        .expect("sign tools/list request event");

    assert_ctxvm_message_kind(&event);
    assert_eq!(
        p_tag_hex(&event),
        Some(server_pk.to_hex()),
        "tools/list request must target the server via p tag"
    );

    let msg = serializers::nostr_event_to_mcp_message(&event.content)
        .expect("event content should be valid JSON-RPC");
    assert!(msg.is_request());
    assert_eq!(msg.method(), Some("tools/list"));

    let v: serde_json::Value =
        serde_json::from_str(&event.content).expect("content must be JSON object");
    assert_eq!(v["jsonrpc"], "2.0");
    assert_eq!(v["id"], serde_json::json!(2));
}

// ── tools/call request ───────────────────────────────────────────────────────

#[test]
fn ctxvm_tools_call_request_has_kind_p_tag_method_and_params() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();

    let call_req = JsonRpcMessage::Request(JsonRpcRequest {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!(3),
        method: "tools/call".to_string(),
        params: Some(serde_json::json!({
            "name": "add",
            "arguments": { "a": 5, "b": 3 }
        })),
    });

    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let builder = serializers::mcp_to_nostr_event(&call_req, CTXVM_MESSAGES_KIND, recipient_tags)
        .expect("tools/call request should serialize to event content");

    let client_keys = Keys::generate();
    let event = builder
        .sign_with_keys(&client_keys)
        .expect("sign tools/call request event");

    assert_ctxvm_message_kind(&event);
    assert_eq!(
        p_tag_hex(&event),
        Some(server_pk.to_hex()),
        "tools/call request must target the server via p tag"
    );

    let msg = serializers::nostr_event_to_mcp_message(&event.content)
        .expect("event content should be valid JSON-RPC");
    assert!(msg.is_request());
    assert_eq!(msg.method(), Some("tools/call"));

    let v: serde_json::Value =
        serde_json::from_str(&event.content).expect("content must be JSON object");
    assert_eq!(v["jsonrpc"], "2.0");
    assert_eq!(v["id"], serde_json::json!(3));
    assert_eq!(v["params"]["name"], "add");
    assert!(
        v["params"]["arguments"].is_object(),
        "tools/call params.arguments must be an object on the wire"
    );
}

// ── tools/list response ───────────────────────────────────────────────────────

#[test]
fn ctxvm_tools_list_response_has_kind_e_tag_and_result() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();
    let client_keys = Keys::generate();
    let client_pk = client_keys.public_key();

    let list_req = JsonRpcMessage::Request(JsonRpcRequest {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!("corr-tools-list"),
        method: "tools/list".to_string(),
        params: Some(serde_json::json!({})),
    });
    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let request_event =
        serializers::mcp_to_nostr_event(&list_req, CTXVM_MESSAGES_KIND, recipient_tags)
            .expect("tools/list request for response correlation should serialize")
            .sign_with_keys(&client_keys)
            .expect("sign tools/list request event for correlation");

    let list_resp = JsonRpcMessage::Response(JsonRpcResponse {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!("corr-tools-list"),
        result: serde_json::json!({ "tools": [] }),
    });

    let response_tags = BaseTransport::create_response_tags(&client_pk, &request_event.id);
    let response_event =
        serializers::mcp_to_nostr_event(&list_resp, CTXVM_MESSAGES_KIND, response_tags)
            .expect("tools/list response should serialize")
            .sign_with_keys(&server_keys)
            .expect("sign tools/list response event");

    assert_ctxvm_message_kind(&response_event);
    assert_eq!(
        p_tag_hex(&response_event),
        Some(client_pk.to_hex()),
        "tools/list response must route back to the client via p tag"
    );
    assert_eq!(
        e_tag_hex(&response_event),
        Some(request_event.id.to_hex()),
        "tools/list response must correlate to the request Nostr event via e tag"
    );

    let v: serde_json::Value =
        serde_json::from_str(&response_event.content).expect("content must be JSON");
    assert_eq!(v["jsonrpc"], "2.0");
    assert_eq!(v["id"], serde_json::json!("corr-tools-list"));
    assert!(v["result"]["tools"].is_array());
}

// ── tools/call response ───────────────────────────────────────────────────────

#[test]
fn ctxvm_tools_call_response_has_kind_e_tag_and_result() {
    let server_keys = Keys::generate();
    let server_pk = server_keys.public_key();
    let client_keys = Keys::generate();
    let client_pk = client_keys.public_key();

    let call_req = JsonRpcMessage::Request(JsonRpcRequest {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!("corr-tools-call"),
        method: "tools/call".to_string(),
        params: Some(serde_json::json!({
            "name": "add",
            "arguments": { "a": 5, "b": 3 }
        })),
    });
    let recipient_tags = BaseTransport::create_recipient_tags(&server_pk);
    let request_event =
        serializers::mcp_to_nostr_event(&call_req, CTXVM_MESSAGES_KIND, recipient_tags)
            .expect("tools/call request for response correlation should serialize")
            .sign_with_keys(&client_keys)
            .expect("sign tools/call request event for correlation");

    let call_resp = JsonRpcMessage::Response(JsonRpcResponse {
        jsonrpc: "2.0".to_string(),
        id: serde_json::json!("corr-tools-call"),
        result: serde_json::json!({
            "content": [{ "type": "text", "text": "8" }],
            "isError": false
        }),
    });

    let response_tags = BaseTransport::create_response_tags(&client_pk, &request_event.id);
    let response_event =
        serializers::mcp_to_nostr_event(&call_resp, CTXVM_MESSAGES_KIND, response_tags)
            .expect("tools/call response should serialize")
            .sign_with_keys(&server_keys)
            .expect("sign tools/call response event");

    assert_ctxvm_message_kind(&response_event);
    assert_eq!(
        p_tag_hex(&response_event),
        Some(client_pk.to_hex()),
        "tools/call response must route back to the client via p tag"
    );
    assert_eq!(
        e_tag_hex(&response_event),
        Some(request_event.id.to_hex()),
        "tools/call response must correlate to the request Nostr event via e tag"
    );

    let v: serde_json::Value =
        serde_json::from_str(&response_event.content).expect("content must be JSON");
    assert_eq!(v["jsonrpc"], "2.0");
    assert_eq!(v["id"], serde_json::json!("corr-tools-call"));
    assert!(v["result"]["content"].is_array());
    assert_eq!(v["result"]["isError"], serde_json::json!(false));
}

// ── Server announcement (kind 11316) ──────────────────────────────────────────

#[test]
fn ctxvm_server_announcement_has_kind_and_required_tags() {
    let server_keys = Keys::generate();

    // MCP-flavoured JSON for wire conformance; not the same content shape as `NostrServerTransport::announce` (flat `ServerInfo` only).
    let content = serde_json::json!({
        "protocolVersion": mcp_protocol_version(),
        "serverInfo": { "name": "Test Server" },
        "capabilities": {},
    });
    let content_str = serde_json::to_string(&content).expect("announcement content must serialize");

    let announcement_tags = vec![
        Tag::custom(
            TagKind::Custom(tags::NAME.into()),
            vec!["Test Server".to_string()],
        ),
        Tag::custom(
            TagKind::Custom(tags::ABOUT.into()),
            vec!["A test server".to_string()],
        ),
        Tag::custom(
            TagKind::Custom(tags::WEBSITE.into()),
            vec!["http://localhost".to_string()],
        ),
        Tag::custom(
            TagKind::Custom(tags::SUPPORT_ENCRYPTION.into()),
            Vec::<String>::new(),
        ),
    ];

    let event = EventBuilder::new(Kind::Custom(SERVER_ANNOUNCEMENT_KIND), content_str)
        .tags(announcement_tags)
        .sign_with_keys(&server_keys)
        .expect("sign server announcement event");

    assert_eq!(
        event.kind,
        Kind::Custom(SERVER_ANNOUNCEMENT_KIND),
        "server announcement must use kind {}",
        SERVER_ANNOUNCEMENT_KIND
    );
    assert_eq!(event.pubkey, server_keys.public_key());

    assert_eq!(
        serializers::get_tag_value(&event.tags, tags::NAME).as_deref(),
        Some("Test Server")
    );
    assert_eq!(
        serializers::get_tag_value(&event.tags, tags::ABOUT).as_deref(),
        Some("A test server")
    );
    assert_eq!(
        serializers::get_tag_value(&event.tags, tags::WEBSITE).as_deref(),
        Some("http://localhost")
    );

    assert!(
        event.tags.iter().any(|t| {
            let parts = t.clone().to_vec();
            parts.len() == 1 && parts.first().map(|s| s.as_str()) == Some(tags::SUPPORT_ENCRYPTION)
        }),
        "support_encryption must be present as a single-element tag"
    );

    let v: serde_json::Value =
        serde_json::from_str(&event.content).expect("announcement content must be JSON");
    assert_eq!(v["protocolVersion"], mcp_protocol_version());
    assert_eq!(v["serverInfo"]["name"], "Test Server");
    assert!(v["capabilities"].is_object());
}