Merged
fix(mcp): add structured data for tool input validation errors #367
fix(mcp): add structured data for tool input validation errors #367
Merged
zhuyutong888Add on 20 days ago
zhuyutong888Collaborators
20 days ago

Paired: GitHub #170 ↔ GitCode !367

What type of PR is this?

/kind bug

Self-checklist:(请自检,在[ ]内打上x,我们将检视你的完成情况,否则会导致pr无法合入)

Linked Closing Issues:
https://gitcode.com/openJiuwen/agent-protocol/issues/30

likedislike
Pull Request has been successfully merged by openJiuwen-bot.
(Thank you for zhuyutong888's contribution.)
Zzhuyutong888Collaborators
20 days ago Associated issue: [MCP] 工具调用参数缺少 JSON Schema 校验:无效参数直接透传至 Handler 导致静默失败
atomgit-bot
atomgit-bot
20 days ago Comments:

变更摘要

本 PR 针对 MCP C++ SDK 中工具入参 Schema 校验失败时错误信息缺少结构化数据的问题进行修复。此前校验异常被统一包装为 std::runtime_error,JSON-RPC 错误响应中只有文本消息。改动引入专用的 ToolInputValidationError 异常类型携带结构化字段,通过只收集首个校验错误的 FirstInputSchemaErrorCollector 生成 errors 数组,并在 SendErrorResponse 中支持可选的 data 字段,使 tools/call 在参数非法时返回带 data 的 INVALID_PARAMS 错误;同时补充了服务端与集成侧用例。

主要改动

  • 新增校验异常类型: 在 tool_manager.h 中定义继承 std::runtime_error 的 ToolInputValidationError,通过 Data() 对外暴露结构化的 JsonValue 错误数据。
  • 输入校验错误收集与错误响应构造: tool_manager.cpp 新增 FirstInputSchemaErrorCollector 与 ValidationAborted,首个校验错误即以 instancePath、message 形式记录并中断后续校验;CallTool 据此抛出携带 {"tool", "errors"} 数据的 ToolInputValidationError,消息中包含出错路径。
  • 错误响应支持 data 字段: SendErrorResponse 增加 const std::optional<JsonValue>& data 参数(默认 std::nullopt)并写入 error.data_,在 HandleToolsCall 中优先捕获 ToolInputValidationError 并以 INVALID_PARAMS 及附带数据返回。
  • 接口与头文件调整: mcp_server_implement.h 引入 <optional> 并同步 SendErrorResponse 签名,保持其他调用点兼容。
  • 测试覆盖: tool_manager_test.cpp 新增通过、缺少必填、类型不匹配、additionalProperties 拒绝/默认允许、null 参数等用例;client_test.cpp 新增集成用例校验 MCPError 的 code、message 及 data 中的 tool 与 errors。
likedislike
Incorrect?
atomgit-bot
atomgit-bot
20 days ago Comments:

代码审查

审查结论

逐文件审查结果

文件 结果
MCP/cpp-sdk/src/server/mcp_server_implement.cpp 无新增问题。已核对:HandleToolsCall 中 catch (const ToolInputValidationError&) 位于 catch (const std::exception&) 之前(顺序正确);ToolInputValidationError 经 tool_manager.h 可见;SendErrorResponse 新增的 data 仅在命中该校验异常时传值,其余 5 处调用走默认 std::nullopt,不改变原有错误响应;ReceiveIncomingMessages 未变更。另已核对 JSONRPCError::data_ 为 std::optional<JsonValue>、Serialize() 会输出 data、base_session.cpp 会把 data_ 落到 ErrorResult.data,故 data 链路可通。
MCP/cpp-sdk/src/server/mcp_server_implement.h 无问题。<optional> 已补;SendErrorResponse 仅在声明处给默认值(定义处未重复),JsonValue 由 shared/jsonrpc.h 提供。
MCP/cpp-sdk/src/server/tool_manager.cpp 1 个 P2 问题(见上:以 collector 是否为空判定校验失败,配合在 error() 中抛异常中断校验,可能与库对 anyOf/oneOf/not 分支试探的容错机制冲突,导致合法参数被误判为 InvalidParams)。其余变更(<exception> 引入、ValidationAborted、FirstInputSchemaErrorCollector、message/data 组装、#include 与谓词改写)核对无正确性/资源问题。
MCP/cpp-sdk/src/server/tool_manager.h 无问题。<stdexcept>/<utility> 补齐,JsonValue 经 shared/jsonrpc.h 可见,取参 by value + std::move,Data() 为 const 引用返回,无泄漏/悬垂风险。
MCP/cpp-sdk/tests/ut/client/client_test.cpp 无问题。新增用例校验了 -32602、message 与 data 结构;MCPError::data() 返回 std::optional<std::string>,与 base_session.cpp 的填充一致;FAIL() 在 try 内为合法返回;catch 顺序(MCPError 先于 std::exception)正确;echo 工具的 inputSchema 确实要求 user_query。
MCP/cpp-sdk/tests/ut/server/tool_manager_test.cpp 无问题。MakeInputSchemaTool 在使用前定义、位于 namespace Mcp 内;TestToolFunc 签名与 ToolFunc 匹配;EXPECT_THROW/NO_THROW 里带逗号的原始字符串位于括号内、宏拆分安全;用例名无重复;文件末尾换行已补。

统计与风险判断

  • P0:0,P1:0,P2:1,P3:0
  • 总体风险:低到中。error data 链路(ToolManager → JSONRPCError → 序列化 → 客户端 ErrorResult/MCPError)完整可用,异常类型新增与 catch 顺序、默认参数兼容性均正确;唯一需要关注的是把"collector 记录到错误"当作"校验失败"判据这一语义替换,在包含组合关键字(anyOf/oneOf/not/if-then-else)的 inputSchema 上存在误拒合法参数的回归路径,建议改为以 validate() 的失败信号为唯一判据、collector 仅作详情补充。
类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
Incorrect?
atomgit-bot
atomgit-bot
20 days ago Comments:

AtomGit AI 助手使用指南

在 PR 评论中使用命令即可触发。支持在普通评论和代码行评论中使用。

功能 命令 说明
代码审查 /ai review 检查代码质量、潜在问题、安全风险
PR 摘要 /ai summary 生成 PR 变更内容的结构化摘要
代码解释 /ai explain 解释代码变更的逻辑和意图
自由提问 @atomgit-bot <问题> 询问关于本 PR 的任何问题
帮助 /ai help 显示此帮助信息

免责声明

AI 助手可能存在误判,请结合自身判断。可以对评论点 👍 或 👎 帮助我们改进。

likedislike
Incorrect?
OopenJiuwen-botCollaborators
20 days ago Set YiyangShao,xinyu-jiuwen as approver
48 messages are collapsed here。 See more
OopenJiuwen-botCollaborators
19 days ago Added label: approvedlgtm-mingo007
openJiuwen-botCollaborators
19 days ago Comments:

Review Code Feedback

  • The label lgtm-mingo007, approved was added to this pull request. It means that mingo007 reviewed the code changes. 👋
Tips
  • If this pull request is not merged while all conditions are met, comment /check-pr to try again. 😄
likedislike
OopenJiuwen-botCollaborators
19 days ago Closed associated issue
OopenJiuwen-botCollaborators
19 days ago Merged pull request
OopenJiuwen-botCollaborators
19 days ago Removed label: ci-successful