modelcontextprotocol / modelcontextprotocol/java-sdk

Add null-safety validation and safe fallbacks for features / clientCapabilities in McpAsyncClient constructor and feature branches

未关闭
#634 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement P3
主要语言
Java
星标
3.7k
派生
1.1k
平均合并
1 天 15 小时
30 天内合并 PR
9

描述

Add null-safety validation and safe fallbacks for features / clientCapabilities in McpAsyncClient constructor and feature branches

Background

The current io.modelcontextprotocol.client.McpAsyncClient constructor performs null checks for transport, requestTimeout, and initializationTimeout, but does not validate the features object itself or its derived fields such as features.clientCapabilities() and features.roots().
Throughout the class, several branches directly dereference clientCapabilities (and its nested capabilities such as roots(), sampling(), and elicitation()), which can lead to NullPointerException with limited diagnostic information.

Example excerpt:

McpAsyncClient(McpClientTransport transport, Duration requestTimeout, Duration initializationTimeout,
               McpClientFeatures.Async features) {
    Assert.notNull(transport, "Transport must not be null");
    Assert.notNull(requestTimeout, "Request timeout must not be null");
    Assert.notNull(initializationTimeout, "Initialization timeout must not be null");

    this.clientInfo = features.clientInfo();                // direct dereference
    this.clientCapabilities = features.clientCapabilities(); // direct dereference
    this.roots = new ConcurrentHashMap<>(features.roots());  // may NPE

    if (this.clientCapabilities.roots() != null) { ... }        // clientCapabilities could be null
    if (this.clientCapabilities.sampling() != null) { ... }
    if (this.clientCapabilities.elicitation() != null) { ... }
}

Reproduction Example

// features may be constructed dynamically, with some fields unset or null
McpAsyncClient client = new McpAsyncClient(
    transport,
    Duration.ofSeconds(5),
    Duration.ofSeconds(10),
    new McpClientFeatures.Async(/* some fields return null */)
);

// During initialization or feature checks, a NullPointerException occurs

Expected Behavior

  • Perform explicit validation or safe fallback initialization during construction, providing clear and actionable error messages (e.g., IllegalArgumentException or McpError) instead of hidden NPEs.
  • Handle optional fields gracefully by using default values or null-safe checks, improving SDK robustness and developer experience.

Proposed Solution

  1. Constructor Validation

    • Add:
      Assert.notNull(features, "Features must not be null");
      
    • Depending on design intent:
      • Strict mode:
        Assert.notNull(features.clientCapabilities(), "ClientCapabilities must not be null");
        
      • Lenient mode: allow clientCapabilities == null, handle null safely later.
  2. Null-Safe Fallbacks

    • Initialize roots safely:
      Map<String, Root> initialRoots = (features.roots() != null)
          ? features.roots()
          : Collections.emptyMap();
      this.roots = new ConcurrentHashMap<>(initialRoots);
      
    • Add double null checks in all feature branches:
      if (this.clientCapabilities != null && this.clientCapabilities.roots() != null) { ... }
      if (this.clientCapabilities != null && this.clientCapabilities.sampling() != null) { ... }
      if (this.clientCapabilities != null && this.clientCapabilities.elicitation() != null) { ... }
      
    • Retain current behavior for declared but unhandled capabilities (still throwing McpError), but ensure the branch is entered safely.
  3. Improve Error Messages

    • Use consistent, developer-friendly error messages like:
      • "Features must not be null"
      • "ClientCapabilities is required when enabling sampling/elicitation"

Compatibility

  • No API changes — only internal validation and null-safety improvements.
  • If “strict mode” is chosen (enforcing non-null clientCapabilities), note this in release notes; otherwise, lenient handling remains fully backward compatible.

Test Recommendations

  • Constructor tests
    • features == null → expect meaningful exception (not NPE).
    • features.roots() == null → no NPE; roots initialized as empty map.
    • features.clientCapabilities() == null → no NPE during construction or branching.
  • Feature branches
    • Missing roots/sampling/elicitation → branches skipped safely, no NPE.
    • Declared capability but missing handler → same McpError as before, readable message.

Impacted Areas

  • io.modelcontextprotocol.client.McpAsyncClient constructor
  • Branches based on clientCapabilities

Benefits

  • Eliminates hidden NullPointerExceptions during initialization.
  • Improves error traceability and developer experience.
  • Small, low-risk change; easy to review and merge.

Environment (example)

  • MCP Java SDK: current main branch
  • JDK: 17 or 21
  • OS: macOS / Linux / Windows

If maintainers agree, I’d be happy to open a PR implementing this improvement.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 io.modelcontextprotocol.client.McpAsyncClient 构造函数开始,检查读取 clientCapabilities、roots、sampling 或 elicitation 的每个分支。遵循 issue 的建议,为 null features 和缺失的可选字段添加构造函数及功能分支测试。完成的标准是:失败会产生明确的验证或安全的回退行为,不会出现隐藏的 NullPointerExceptions,同时现有的 McpError 行为保持不变。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
api, backend
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。