MCP 工具参考
Sumi-Docs-MCP 提供四个无会话状态的工具。所有参数对象都会经过严格校验; 未知字段和格式错误的值会在执行前被拒绝。
| 工具 | 参数 | 结果 |
|---|---|---|
list_docs |
{} |
文档路径、标题、可选修改时间和可选公开 URL |
search_docs |
{ "query": string } |
按相关度排序的词法匹配、标题、摘要和可选 URL |
fetch_doc |
{ "path": string } |
解析后的内容、frontmatter、标题和可选公开 URL |
get_openapi_spec |
{ "endpoint"?: string } |
完整 OpenAPI 对象或一个精确端点 |
搜索词长度必须为 1 到 200 个字符。搜索采用支持 Unicode 的词法子串匹配, 不是语义搜索或向量搜索。分数相同时按路径排序,因此同一文档集上的结果稳定。
fetch_doc 只接受索引中已存在的受限相对 .md 或 .mdx 路径,绝不会把
客户端输入直接作为文件系统路径打开。
工具错误会设置 isError: true 并返回净化后的消息。_meta.errorCode 为
PATH_NOT_FOUND、INVALID_INPUT 或 PARSE_ERROR;不会暴露绝对路径或堆栈。
成功和失败结果的 _meta 还会标明 MCP 协议版本和服务能力。
stdio 在第一次内容工具调用时加载只读文档快照;Streamable HTTP 在开始监听前加载同一 快照。后续调用会复用该快照直到进程退出,因此源文档变化后需要重启进程。
