Add null-safety validation and safe fallbacks for features / clientCapabilities in McpAsyncClient constructor and feature branches
維護者通常 2 天內回覆
還沒有人認領這個 Issue。
評估
研究方向
從 io.modelcontextprotocol.client.McpAsyncClient 建構函式開始,檢查每個讀取 clientCapabilities、roots、sampling 或 elicitation 的分支。遵循 issue 的建議,為 null features 和缺少的選用欄位新增建構函式及功能分支測試。完成的標準是:失敗會產生明確的驗證或安全的回退行為,不會出現隱藏的 NullPointerExceptions,同時現有的 McpError 行為保持不變。
由索引模型根據 Issue 內容生成。
描述
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.,
IllegalArgumentExceptionorMcpError) instead of hidden NPEs. - Handle optional fields gracefully by using default values or null-safe checks, improving SDK robustness and developer experience.
Proposed Solution
-
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.
- Strict mode:
- Add:
-
Null-Safe Fallbacks
- Initialize
rootssafely: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.
- Initialize
-
Improve Error Messages
- Use consistent, developer-friendly error messages like:
"Features must not be null""ClientCapabilities is required when enabling sampling/elicitation"
- Use consistent, developer-friendly error messages like:
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;rootsinitialized 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
McpErroras before, readable message.
- Missing
Impacted Areas
io.modelcontextprotocol.client.McpAsyncClientconstructor- 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
mainbranch - JDK: 17 or 21
- OS: macOS / Linux / Windows
If maintainers agree, I’d be happy to open a PR implementing this improvement.
- 主要語言
- Java
- 星號
- 3.7k
- 分支
- 1.1k
- 平均合併
- 1 天 15 小時
- 30 天內合併 PR
- 9
環境準備
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
modelcontextprotocol/java-sdk 的其他 Issue
-
area/transport bug P2
難度 2/5 1-3 小時 新手友好度 88/100
modelcontextprotocol/java-sdk#1136 ·
維護者通常 2 天內回覆
-
area/client bug P2
難度 2/5 1-3 小時 新手友好度 84/100
modelcontextprotocol/java-sdk#1124 · 1 則留言 ·
維護者通常 2 天內回覆
-
ServerCapabilities.logging is added unconditionally, overriding the caller's explicit capabilities 未關閉bug P2 ready for work
難度 2/5 1-3 小時 新手友好度 68/100
modelcontextprotocol/java-sdk#1086 · 1 則留言 ·
維護者通常 2 天內回覆
-
enhancement good first issue P3
難度 2/5 1-3 小時 新手友好度 82/100
modelcontextprotocol/java-sdk#1067 ·
維護者通常 2 天內回覆
-
bug P2 ready for work
難度 2/5 1-3 小時 新手友好度 74/100
modelcontextprotocol/java-sdk#898 · 1 則留言 ·
維護者通常 2 天內回覆
查看 modelcontextprotocol/java-sdk 的全部 Issue
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 84/100
維護者通常 1 天內回覆
-
ci-failure-cause test-failure
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
enhancement
難度 2/5 1-3 小時 新手友好度 65/100
nextcloud/notes-android#3367 ·
維護者通常 1 天內回覆
-
Feature
難度 2/5 1-3 小時 新手友好度 68/100
MuntashirAkon/AppManager#2058 ·
-
SarifLogger: artifactLocation.uri is not properly encoded for file names containing '#', '?', or '%' 未關閉
難度 2/5 1-3 小時 新手友好度 76/100
checkstyle/checkstyle#21721 ·
維護者通常 1 天內回覆