docs-search

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Docs Search

文档搜索

Search the local Grounded Docs index for library documentation. These commands return structured data (JSON by default in non-interactive sessions) and never modify the index.

搜索本地Grounded Docs索引中的库文档。这些命令返回结构化数据（非交互式会话中默认JSON格式），且绝不会修改索引。

When to use

适用场景

You need to answer a question about a library's API or behaviour.
You want to check which libraries and versions are already indexed.
You need to resolve which documentation version best matches a constraint.

Always run

list

first if you are unsure whether a library has been indexed. If nothing is indexed yet, use the docs-manage skill to scrape documentation before searching.

你需要解答关于某个库的API或行为的问题。
你想要查看哪些库及其版本已被索引。
你需要确定哪个文档版本最符合约束条件。

如果你不确定某个库是否已被索引，请先运行

list

命令。如果尚未索引任何内容，请先使用docs-manage技能抓取文档，再进行搜索。

Commands

命令

list

List every indexed library and its available versions.

bash

npx @arabold/docs-mcp-server@latest list [--output yaml]

Flag	Description
`--output json\|yaml\|toon`	Structured output format (default: JSON in non-interactive)
`--server-url <url>`	Connect to a remote pipeline worker instead of the local store
`--quiet`	Suppress non-error diagnostics
`--verbose`	Enable debug logging

Example output (YAML):

yaml

- library: react
  versions:
    - "19.0.0"
    - "18.3.1"
- library: typescript
  versions:
    - "5.7.0"

列出所有已索引的库及其可用版本。

bash

npx @arabold/docs-mcp-server@latest list [--output yaml]

标记	描述
`--output json\|yaml\|toon`	结构化输出格式（非交互式会话默认：JSON）
`--server-url <url>`	连接到远程流水线工作节点，而非本地存储
`--quiet`	抑制非错误诊断信息
`--verbose`	启用调试日志

示例输出（YAML格式）：

yaml

- library: react
  versions:
    - "19.0.0"
    - "18.3.1"
- library: typescript
  versions:
    - "5.7.0"

search

Search documents in an indexed library by natural-language query.

bash

npx @arabold/docs-mcp-server@latest search <library> "<query>" [options]

Flag	Alias	Default	Description
`--version <ver>`	`-v`	latest	Version constraint (exact or range, e.g. `18.x` , `5.2.x` )
`--limit <n>`	`-l`	`5`	Maximum number of results
`--exact-match`	`-e`	`false`	Only match the exact version, no fallback
`--embedding-model <model>`			Embedding model (e.g. `openai:text-embedding-3-small` )
`--server-url <url>`			Remote pipeline worker URL
`--output json\|yaml\|toon`		JSON	Structured output format
`--quiet`			Suppress non-error diagnostics
`--verbose`			Enable debug logging

Example:

bash

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --version 18.x --limit 3 --output yaml

Each result contains a content snippet, source URL, and relevance score.

通过自然语言查询搜索已索引库中的文档。

bash

npx @arabold/docs-mcp-server@latest search <library> "<query>" [options]

标记	别名	默认值	描述
`--version <ver>`	`-v`	latest	版本约束（精确版本或范围，例如 `18.x` 、 `5.2.x` ）
`--limit <n>`	`-l`	`5`	最大结果数量
`--exact-match`	`-e`	`false`	仅匹配精确版本，不使用回退版本
`--embedding-model <model>`			嵌入模型（例如 `openai:text-embedding-3-small` ）
`--server-url <url>`			远程流水线工作节点URL
`--output json\|yaml\|toon`		JSON	结构化输出格式
`--quiet`			抑制非错误诊断信息
`--verbose`			启用调试日志

示例：

bash

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --version 18.x --limit 3 --output yaml

每个结果包含内容片段、源URL和相关性评分。

find-version

Resolve the best matching documentation version for a library.

bash

npx @arabold/docs-mcp-server@latest find-version <library> [--version <pattern>]

Flag	Alias	Description
`--version <pattern>`	`-v`	Version pattern to match (supports ranges)
`--server-url <url>`		Remote pipeline worker URL
`--output json\|yaml\|toon`		Structured output format
`--quiet`		Suppress non-error diagnostics
`--verbose`		Enable debug logging

Example:

bash

npx @arabold/docs-mcp-server@latest find-version react --version "18.x" --output yaml

Returns the resolved version string and library metadata.

解析与库最匹配的文档版本。

bash

npx @arabold/docs-mcp-server@latest find-version <library> [--version <pattern>]

标记	别名	描述
`--version <pattern>`	`-v`	要匹配的版本模式（支持范围）
`--server-url <url>`		远程流水线工作节点URL
`--output json\|yaml\|toon`		结构化输出格式
`--quiet`		抑制非错误诊断信息
`--verbose`		启用调试日志

示例：

bash

npx @arabold/docs-mcp-server@latest find-version react --version "18.x" --output yaml

返回解析后的版本字符串和库元数据。

Interpreting output

输出解读

All three commands emit structured data to stdout. Diagnostics and progress messages go to stderr and are suppressed by default in non-interactive sessions. Use

--verbose

(or set

LOG_LEVEL=INFO

) to re-enable them. Use

--quiet

to suppress all non-error diagnostics regardless of session type.

To capture results programmatically, parse stdout as JSON (the default) or request

--output yaml

for a more readable format.

这三个命令都会向stdout输出结构化数据。诊断信息和进度消息会发送到stderr，在非交互式会话中默认被抑制。使用

--verbose

（或设置

LOG_LEVEL=INFO

）可重新启用这些信息。无论会话类型如何，使用

--quiet

可抑制所有非错误诊断信息。

要以编程方式捕获结果，请将stdout解析为JSON（默认格式），或使用

--output yaml

请求更易读的格式。

Typical workflow

典型工作流

bash

undefined

bash

undefined

1. Check what is indexed

1. 检查已索引的内容

npx @arabold/docs-mcp-server@latest list --output yaml

2. Search for relevant docs

2. 搜索相关文档

npx @arabold/docs-mcp-server@latest search react "server components" --version 19.x --output yaml

3. If no results, index the docs first (see docs-manage skill), then retry

3. 如果没有结果，先索引文档（请查看docs-manage技能），然后重试

undefined

undefined