xyz-rust 0.4.13

One definition, three interfaces(CLI / HTTP / MCP)— a command toolkit for Rust
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
// mcp 前端逻辑层测试(Go mcp_test.go 的单元面;线上往返已在 example
// stdio 冒烟验证——rmcp 3.1.4 无进程内 transport)。覆盖:版本校验、
// 参数解析、注解解析、工具元数据/inputSchema/outputSchema、默认值语义。

use std::sync::Arc;

use rmcp::handler::server::ServerHandler;

use crate::Ctx;
use crate::errors;
use crate::mcp::{DEFAULT_VERSIONS, Options, handler, transport};
use crate::registry::Registry;
use crate::spec::command::{Command, MCPFieldHint, MCPHints};
use xyz_rust::XyzArgs;

#[derive(XyzArgs)]
struct SumArgs {
    #[xyz(desc = "左操作数", required)]
    a: i64,
    #[xyz(desc = "右操作数", required)]
    b: i64,
    #[xyz(desc = "全局 10", default = "10")]
    k: i32,
}

#[derive(serde::Serialize, xyz_rust::XyzOutput)]
struct SumResp {
    #[serde(rename = "sum")]
    sum: i64,
}

fn sum(_: &Ctx, in_: &SumArgs) -> errors::Result<SumResp> {
    Ok(SumResp { sum: in_.a + in_.b })
}

fn reg() -> Registry {
    let reg = Registry::new();
    Command::new("math.sum", sum)
        .summary("求和")
        .description("两个整数相加")
        .mcp(MCPHints {
            name: String::new(),
            description: String::new(),
            title: "求和工具".into(),
            meta: serde_json::Map::new(),
            skip: false,
            annotations: vec!["read".into(), "title:求和工具".into(), "destructive".into()],
            fields: std::collections::HashMap::from([(
                "k".to_string(),
                MCPFieldHint {
                    default: Some(15.into()),
                    description: None,
                },
            )]),
        })
        .register(&reg)
        .unwrap();
    reg
}

#[test]
fn versions_validation() {
    assert!(transport::validate_versions(&[]).is_ok());
    assert!(transport::validate_versions(&["2025-11-25".into()]).is_ok());
    assert!(transport::validate_versions(&["2026-07-28".into()]).is_ok());
    let err = transport::validate_versions(&["1999-01-01".into()]).unwrap_err();
    assert!(
        err.to_string().contains("unknown protocol version"),
        "{err}"
    );
    let err = transport::validate_versions(&["".into()]).unwrap_err();
    assert!(err.to_string().contains("empty protocol version"), "{err}");
}

#[test]
fn transport_version_constraints() {
    // streamable HTTP:2026-07-28 需无状态模式(与 SDK 内部约束一致)
    let mut opts = Options {
        versions: vec![crate::mcp::PROTOCOL_V2026_07_28.into()],
        ..Default::default()
    };
    assert!(transport::validate_transport_versions("http", &opts).is_err());
    opts.stateless = true;
    assert!(transport::validate_transport_versions("http", &opts).is_ok());
    // stdio 全版本
    let mut s_opts = Options {
        versions: vec![crate::mcp::PROTOCOL_V2025_03_26.into()],
        ..Default::default()
    };
    assert!(transport::validate_transport_versions("stdio", &s_opts).is_ok());
    s_opts.versions = vec![];
    assert!(transport::validate_transport_versions("http", &s_opts).is_ok());
}

#[test]
fn default_versions_newest_first() {
    assert_eq!(DEFAULT_VERSIONS[0], "2026-07-28");
    assert_eq!(DEFAULT_VERSIONS.len(), 5);
}

#[test]
fn build_creates_tool_metadata() {
    let mut opts = Options::default();
    // 钉定→supported_protocol_versions 收窄
    let srv = handler::build(&reg(), &opts, Arc::new(Ctx::new())).unwrap();
    let tool = srv.get_tool("math.sum").unwrap();
    assert_eq!(tool.name, "math.sum");
    assert_eq!(tool.description.as_deref(), Some("求和\n\n两个整数相加"));
    // inputSchema:MCP 默认 15 替换全局 10
    let inschema = tool.input_schema.clone();
    let v: serde_json::Value = serde_json::json!(serde_json::to_value(&*inschema).unwrap());
    assert_eq!(v["properties"]["k"]["default"], 15);
    assert_eq!(v["properties"]["a"]["type"], "integer");
    assert_eq!(v["required"], serde_json::json!(["a", "b"]));
    // outputSchema 同源反射
    let out = tool.output_schema.as_ref().unwrap();
    let ov: serde_json::Value = serde_json::to_value(&**out).unwrap();
    assert_eq!(ov["properties"]["sum"]["type"], "integer");
    // 注解:read → read_only_hint=true;destructive;title
    let ann = tool.annotations.as_ref().unwrap();
    assert_eq!(ann.read_only_hint, Some(true));
    assert_eq!(ann.destructive_hint, Some(true));
    assert_eq!(ann.title.as_deref(), Some("求和工具"));

    // 钉定子集反映在 supported_protocol_versions
    opts.versions = vec!["2025-11-25".into()];
    let pinned = handler::build(&reg(), &opts, Arc::new(Ctx::new())).unwrap();
    let supported = pinned.supported_protocol_versions().into_owned();
    assert_eq!(supported.len(), 1);
    assert_eq!(supported[0].as_str(), "2025-11-25");
}

#[test]
fn impl_defaults() {
    let srv = handler::build(&reg(), &Options::default(), Arc::new(Ctx::new())).unwrap();
    let info = srv.get_info();
    assert_eq!(info.server_info.name, crate::cli::app::bin_name());
    assert_eq!(info.server_info.version, "0.0.0");
    // initialize 必须声明 tools 能力(MCP MUST),否则按能力协商的客户端
    // 不发 tools/list;工具集固定、不发 list_changed,故线上形状为
    // {"tools":{}}。
    let caps = serde_json::to_value(&info.capabilities).unwrap();
    assert_eq!(caps, serde_json::json!({ "tools": {} }));
    // 声明的协议版本必须是仍带 initialize 握手的修订(2026-07-28 起
    // LATEST 属无握手世代,不能出现在 initialize 结果里)。
    assert!(info.protocol_version.has_initialize());
}

#[test]
fn parse_args_forms() {
    let (t, o) = crate::mcp::args::parse_args(&s2(&[
        "http",
        "--addr",
        ":9000",
        "--versions=a,b",
        "--json-response",
        "--stateless",
        "--bearer=x",
        "--session-timeout",
        "90s",
        "--name",
        "N",
        "--server-version",
        "V",
    ]))
    .unwrap();
    assert_eq!(t, "http");
    assert_eq!(o.addr, ":9000");
    assert_eq!(o.versions, vec!["a", "b"]);
    assert!(o.json_response);
    assert!(o.stateless);
    assert_eq!(o.bearer_tokens, vec!["x"]);
    assert_eq!(o.session_timeout, std::time::Duration::from_secs(90));
    assert_eq!(o.name, "N");
    assert_eq!(o.version, "V");

    let err = crate::mcp::args::parse_args(&s2(&[])).unwrap_err();
    assert!(err.to_string().contains("missing transport"), "{err}");
    let err = crate::mcp::args::parse_args(&s2(&["x", "y"])).unwrap_err();
    assert!(err.to_string().contains("unexpected argument"), "{err}");
    // 未识别 --key v 现在透传为通道默认参数(与 serve 一致)
    let (_, o) = crate::mcp::args::parse_args(&s2(&["http", "--index", "./wiki"])).unwrap();
    assert_eq!(o.defaults["index"], "./wiki");
    // 缺值的悬空 flag 报错
    let err = crate::mcp::args::parse_args(&s2(&["--dangling"])).unwrap_err();
    assert!(err.to_string().contains("needs an argument"), "{err}");
}

#[test]
fn options_merge_defaults() {
    let base = Options {
        addr: ":9000".into(),
        bearer_tokens: vec!["b".into()],
        stateless: true,
        ..Default::default()
    };
    let mut from_flags = Options::default();
    from_flags.merge_defaults(&base);
    assert_eq!(from_flags.addr, ":9000");
    assert_eq!(from_flags.bearer_tokens, vec!["b"]);
    assert!(from_flags.stateless);
    // 命令行 flag 优先
    let mut from_flags2 = Options {
        addr: ":7777".into(),
        ..Default::default()
    };
    from_flags2.merge_defaults(&base);
    assert_eq!(from_flags2.addr, ":7777");
}

fn s2(v: &[&str]) -> Vec<String> {
    v.iter().map(|s| s.to_string()).collect()
}

#[test]
fn block_envelope_passes_through() {
    use rmcp::model::CallToolResponse;
    let env = serde_json::json!({"content":[
        {"type":"text","text":"hello"},
        {"type":"image","mimeType":"image/png","data":"aGVsbG8="}
    ]});
    let resp = handler::success_response(env.clone(), None, true);
    let CallToolResponse::Complete(res) = resp else {
        panic!("want complete response");
    };
    assert!(res.is_error.is_none());
    // Content 块保真;structuredContent 仍持信封。
    match &res.content[0] {
        rmcp::model::ContentBlock::Text(t) => assert_eq!(t.text, "hello"),
        other => panic!("want text block, got {other:?}"),
    }
    match &res.content[1] {
        rmcp::model::ContentBlock::Image(img) => {
            assert_eq!(img.data, "aGVsbG8=");
            assert_eq!(img.mime_type, "image/png");
        }
        other => panic!("want image block, got {other:?}"),
    }
    assert_eq!(res.structured_content, Some(env));

    // 普通 JSON 不误报:走 §12.5 文本+structured 双内容。
    let resp = handler::success_response(serde_json::json!({"msg": "hi"}), None, true);
    let CallToolResponse::Complete(plain) = resp else {
        panic!("want complete response");
    };
    assert_eq!(plain.content.len(), 1);
    assert!(matches!(
        plain.content[0],
        rmcp::model::ContentBlock::Text(_)
    ));
    assert_eq!(
        plain.structured_content,
        Some(serde_json::json!({"msg": "hi"}))
    );
}

#[test]
fn mcp_name_override() {
    use crate::spec::command::Command;

    fn hello(_: &Ctx, _: &SumArgs) -> errors::Result<String> {
        Ok("hi".to_string())
    }

    // §12.4a:覆写名是 tools/list 通告与 tools/call 接受的唯一名字。
    let reg = Registry::new();
    Command::new("svc.echo", hello)
        .mcp(MCPHints {
            name: "sys.echo".into(),
            ..Default::default()
        })
        .register(&reg)
        .unwrap();
    let srv = handler::build(&reg, &Options::default(), Arc::new(Ctx::new())).unwrap();
    assert!(
        srv.get_tool("sys.echo").is_some(),
        "override name must be listed"
    );
    assert!(
        srv.get_tool("svc.echo").is_none(),
        "original name must not be callable once overridden"
    );

    // 覆写名同样受 §3.1 文法约束(注册期报错)。
    let reg2 = Registry::new();
    let err = Command::new("svc.echo", hello)
        .mcp(MCPHints {
            name: "bad name!".into(),
            ..Default::default()
        })
        .register(&reg2)
        .unwrap_err();
    assert!(
        err.to_string().contains("mcp name override"),
        "want grammar rejection, got: {err}"
    );
}

#[test]
fn result_meta_shape() {
    use crate::errors;
    use handler::{result_meta, success_response};
    use rmcp::model::CallToolResponse;

    // §12.8:成功结果 _meta.xyz = 身份 + 库版本 + 命令 + 耗时(+ 自定义头)。
    let meta = result_meta(
        "app",
        "1.2",
        &[("X-Env".to_string(), "test".to_string())],
        "math.sum",
        7,
        None,
    );
    let v = serde_json::to_value(&meta).unwrap();
    let xyz = &v["xyz"];
    assert_eq!(xyz["app_name"], "app");
    assert_eq!(xyz["app_version"], "1.2");
    assert_eq!(xyz["sdk_version"], crate::version::SDK_VERSION);
    assert_eq!(xyz["command"], "math.sum");
    assert_eq!(xyz["duration_ms"], 7);
    assert_eq!(xyz["headers"]["X-Env"], "test");
    assert!(xyz.get("error").is_none());

    // 失败结果:_meta.xyz.error 带 kind/code/detail(§8.6 投影)。
    let err = errors::Error::new(errors::Kind::NotFound, "user 7")
        .with_code("USER_NOT_FOUND")
        .with_detail("user_id", serde_json::json!(7));
    let body = errors::error_body(&err);
    let meta = result_meta("app", "dev", &[], "svc.get", 3, Some(&body));
    let v = serde_json::to_value(&meta).unwrap();
    assert_eq!(v["xyz"]["error"]["kind"], "not_found");
    assert_eq!(v["xyz"]["error"]["code"], "USER_NOT_FOUND");
    assert_eq!(v["xyz"]["error"]["detail"]["user_id"], 7);

    // success_response 把 meta 挂到结果上。
    let resp = success_response(serde_json::json!("ok"), Some(meta), true);
    let CallToolResponse::Complete(res) = resp else {
        panic!("complete");
    };
    assert!(res.meta.is_some());
}

#[test]
fn rich_error_http_status_override() {
    use crate::errors;
    // §8.5:status 覆盖 Kind 推导(HTTP 通道语义,投影层可读)。
    let e = errors::Error::new(errors::Kind::Conflict, "duplicate").with_status(410);
    assert_eq!(errors::error_status(&e), 410);
    let plain = errors::Error::new(errors::Kind::NotFound, "no");
    assert_eq!(errors::error_status(&plain), 404);
    // wrap 后富化层仍可从链上读回(from_chain)。
    let wrapped = errors::Error::wrap(errors::Kind::Unavailable, e);
    let body = errors::error_body(&wrapped);
    assert_eq!(body.code, None); // 外层无 code;kind 取链上首个分类载体
    assert_eq!(body.kind, errors::Kind::Unavailable);
}

#[test]
fn tool_metadata_rich_overrides() {
    use crate::spec::command::{Command, MCPFieldHint, MCPHints};

    #[derive(XyzArgs)]
    struct RichArgs {
        #[xyz(desc = "原描述")]
        k: i32,
    }
    fn rich(_: &Ctx, _: &RichArgs) -> errors::Result<String> {
        Ok("ok".into())
    }
    let reg = Registry::new();
    let mut meta = serde_json::Map::new();
    meta.insert("team".into(), serde_json::json!("core"));
    Command::new("rich.tool", rich)
        .summary("摘要")
        .description("长描述")
        .mcp(MCPHints {
            name: String::new(),
            description: "覆写描述".into(),
            title: "人类标题".into(),
            meta,
            skip: false,
            annotations: vec!["read".into()],
            fields: std::collections::HashMap::from([(
                "k".to_string(),
                MCPFieldHint {
                    default: None,
                    description: Some("字段描述覆写".into()),
                },
            )]),
        })
        .register(&reg)
        .unwrap();
    let srv = handler::build(&reg, &Options::default(), Arc::new(Ctx::new())).unwrap();
    let tool = srv.get_tool("rich.tool").unwrap();
    // description 覆写(否则会是 "摘要\n\n长描述")。
    assert_eq!(tool.description.as_deref(), Some("覆写描述"));
    // title 进 annotations.title(§12.4 载体)。
    let ann = tool.annotations.as_ref().expect("annotations");
    assert_eq!(ann.title.as_deref(), Some("人类标题"));
    // 工具级 _meta。
    let meta = tool.meta.as_ref().expect("tool _meta");
    assert_eq!(meta.0["team"], "core");
    // 字段描述覆写进 inputSchema(MCP 在 build_schema 前应用)。
    let v: serde_json::Value = serde_json::to_value(&*tool.input_schema).unwrap();
    assert_eq!(v["properties"]["k"]["description"], "字段描述覆写");
}

#[test]
fn non_object_results_omit_output_schema_and_structured_content() {
    use rmcp::model::{CallToolResponse, ProtocolVersion};

    // 数组返回:outputSchema 构建期不发射(有 schema 就必须有合规
    // structuredContent,数组 schema 不可能有——ddc#9)。
    fn arr(_: &Ctx, _: &SumArgs) -> errors::Result<Vec<String>> {
        Ok(vec!["a".into(), "b".into()])
    }
    let reg = Registry::new();
    Command::new("arr.list", arr).register(&reg).unwrap();
    Command::new("math.sum", sum).register(&reg).unwrap();
    let srv = handler::build(&reg, &Options::default(), Arc::new(Ctx::new())).unwrap();
    assert!(
        srv.get_tool("arr.list").unwrap().output_schema.is_none(),
        "array-typed result must not advertise outputSchema"
    );
    assert!(
        srv.get_tool("math.sum").unwrap().output_schema.is_some(),
        "object-typed result keeps its outputSchema"
    );

    // 响应侧:裸数组不发 structuredContent,文本照常。
    let resp = handler::success_response(serde_json::json!(["a", "b"]), None, true);
    let CallToolResponse::Complete(res) = resp else {
        panic!("want complete response");
    };
    assert!(res.structured_content.is_none());
    assert!(matches!(res.content[0], rmcp::model::ContentBlock::Text(_)));
    // 对象结果:照常双内容。
    let resp = handler::success_response(serde_json::json!({"sum": 3}), None, true);
    let CallToolResponse::Complete(res) = resp else {
        panic!("want complete response");
    };
    assert_eq!(res.structured_content, Some(serde_json::json!({"sum": 3})));

    // 版本门控:< 2025-06-18 时 outputSchema 逐请求剥离,structuredContent
    // 也不发射;2025-06-18 及以后维持(None = 无握手世代,视为最新)。
    let tools = handler::shape_tools(srv_tools(&srv), None);
    assert!(tools.iter().any(|t| t.output_schema.is_some()));
    let tools = handler::shape_tools(srv_tools(&srv), Some(&ProtocolVersion::V_2025_03_26));
    assert!(tools.iter().all(|t| t.output_schema.is_none()));
    let tools = handler::shape_tools(srv_tools(&srv), Some(&ProtocolVersion::V_2025_06_18));
    assert!(tools.iter().any(|t| t.output_schema.is_some()));
    assert!(!handler::supports_structured(Some(
        &ProtocolVersion::V_2024_11_05
    )));
    assert!(handler::supports_structured(Some(
        &ProtocolVersion::V_2025_11_25
    )));
    assert!(handler::supports_structured(None));
}

fn srv_tools(srv: &handler::XyzServer) -> Vec<rmcp::model::Tool> {
    ["arr.list", "math.sum"]
        .iter()
        .filter_map(|n| srv.get_tool(n))
        .collect()
}

#[test]
fn pinned_versions_drive_the_initialize_handshake_version() {
    use rmcp::model::ProtocolVersion;

    // 钉定集内最新(rmcp 的协商兜底直接用该值,超出钉定集会漏给客户端)。
    let opts = Options {
        versions: vec!["2024-11-05".into(), "2025-03-26".into()],
        ..Options::default()
    };
    let srv = handler::build(&reg(), &opts, Arc::new(Ctx::new())).unwrap();
    assert_eq!(srv.get_info().protocol_version.as_str(), "2025-03-26");

    // 未钉定:仍带 initialize 握手的最新修订。
    let srv = handler::build(&reg(), &Options::default(), Arc::new(Ctx::new())).unwrap();
    assert_eq!(
        srv.get_info().protocol_version,
        ProtocolVersion::LATEST_WITH_INITIALIZE
    );
}