opensource/mateclaw
2
0
Fork 0
mirror of https://gitee.com/mateos/mateclaw.git synced 2026-09-15 20:08:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(mcp): align /tools javadoc with HTTP 200 + biz-code convention

Browse Source
This commit is contained in:
matevip 2026-05-02 15:41:53 +08:00
parent a8d94681e5
commit cbc34a12c9
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
mateclaw-server/src/main/java/vip/mate/tool/mcp/controller/McpServerController.java
View File

@ -82,10 +82,21 @@ public class McpServerController {
* RFC-03 Lane A3 — list the tools surfaced by an MCP server (QwenPaw #2495). * RFC-03 Lane A3 — list the tools surfaced by an MCP server (QwenPaw #2495).
* *
* <p>Reads from the in-memory cache populated on connect/refresh, so the * <p>Reads from the in-memory cache populated on connect/refresh, so the
* call is non-blocking and safe to poll from the admin UI. Returns an * call is non-blocking and safe to poll from the admin UI.
* empty list when the server is configured but disconnected, in error *
* state, or has no tools — never an error response in that case. * <p><b>Response contract</b> (matches project convention "HTTP 200 + biz code"):
* 404 is reserved for "the server id doesn't exist". * <ul>
* <li>Server exists, connected with discovered tools → HTTP 200, {@code code=200},
* {@code data} = list of {name, description, inputSchema}.</li>
* <li>Server exists but disconnected / in error / no tools → HTTP 200,
* {@code code=200}, {@code data=[]}. The UI renders "no tools yet" rather
* than an error toast.</li>
* <li>Server id does not exist → HTTP 200, {@code code=500},
* {@code msg="MCP server 不存在: {id}"}. The not-found path goes through
* {@code MateClawException("err.mcp.not_found")} which the global handler
* maps to a 200/500 envelope; callers detect not-found via {@code code != 200},
* not via the HTTP status (consistent with every other CRUD endpoint).</li>
* </ul>
*/ */
@Operation(summary = "列出 MCP Server 已发现的工具") @Operation(summary = "列出 MCP Server 已发现的工具")
@GetMapping("/{id}/tools") @GetMapping("/{id}/tools")