Available tools
The three read-only tools the docs MCP exposes — search_docs, list_docs, get_doc — with their inputs, return values, and markdownPath usage.
Available tools
The docs MCP exposes three read-only tools, all of which read the documentation published on the docs site.
| Tool | Input | Returns |
|---|---|---|
search_docs | Required query (1–200 characters); optional locale (zh-CN or en, default zh-CN) and limit (1–20, default 10) | title, excerpt, url, and markdownPath of matching pages |
list_docs | Optional locale (zh-CN or en; both languages are listed when omitted) | title, description, url, and markdownPath of published pages |
get_doc | Required markdownPath, passed through unchanged from either tool above | The full Markdown of one page, starting with its Source page address |
markdownPath is the path MCP uses to read a page and cannot be opened as a web address: search or list first, then pass markdownPath through to get_doc exactly as returned. Cite the url from the result, or the Source address at the start of the get_doc output.
Example
Hand the task to an agent:
Use qnbot_docs to search the latest VetraGlove Pro Python SDK device connection documentation.
Call search_docs first, then get_doc for the most relevant page;
give the steps from the documentation and include the page URL. Do not substitute unpublished repository content.If you do not know which chapters exist yet, have the agent call list_docs first (locale set to zh-CN or en) and pick a page from the result.
Search results are excerpts only. Before answering with parameters, code, or step-by-step instructions, call get_doc again to confirm the full text.