可用工具
文档 MCP 暴露的三个只读工具 search_docs、list_docs、get_doc 的输入、返回内容,以及 markdownPath 的用法。
最新文档
可用工具
文档 MCP 只暴露三个只读工具,全部读取文档站上已经发布的内容。
| 工具 | 输入 | 返回内容 |
|---|---|---|
search_docs | 必填 query(1–200 字符);可选 locale(zh-CN 或 en,默认 zh-CN)、limit(1–20,默认 10) | 匹配页面的 title、excerpt、url、markdownPath |
list_docs | 可选 locale(zh-CN 或 en;省略则列出两种语言) | 已发布页面的 title、description、url、markdownPath |
get_doc | 必填 markdownPath,使用上述两个工具返回的原值 | 一页完整 Markdown,开头含 Source 页面地址 |
markdownPath 是 MCP 读取页面的路径,不能当网页地址打开:先搜索或列举,再把结果里的 markdownPath 原样传给 get_doc。引用页面时用结果中的 url,或 get_doc 开头的 Source 地址。
使用示例
把任务交给智能体:
请使用 qnbot_docs 搜索最新版 VetraGlove Pro Python SDK 的设备连接文档。
先调用 search_docs,再用 get_doc 读取最相关的页面;
按文档给出步骤,并附上页面 URL。不要用未发布的仓库内容代替线上文档。如果还不知道有哪些章节,可以先让智能体调用 list_docs(用 locale 指定 zh-CN 或 en),再从结果中选择页面读取。
搜索结果只是摘录。回答具体参数、代码或操作步骤时,应再调用 get_doc 核对全文。