# @arabold/docs-mcp-server 中文文档

规范地址：https://npmcn.com/package/%40arabold/docs-mcp-server/

版本：3\.4\.1
npm 元数据更新时间：2026-10-25T16:57:23.974Z
中文译文更新时间：2026-11-06T13:25:06.931Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40arabold/docs-mcp-server
原文对照：https://npmcn.com/package/%40arabold/docs-mcp-server/?lang=original
项目主页：https://github.com/arabold/docs-mcp-server#readme
源码仓库：https://github.com/arabold/docs-mcp-server

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.6 MB，95 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：64 个
- 首次发布：2025-03-30T13:32:51.114Z
- 最新版本发布：2026-10-25T16:57:23.787Z
- 近 30 天下载量：6407（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：86（近 12 个月 39 个）

## 中文简介

用于获取和搜索文档的 MCP 服务器

## 安装

```sh
npm install @arabold/docs-mcp-server
```

也可以使用：`pnpm add @arabold/docs-mcp-server`、`yarn add @arabold/docs-mcp-server`、`bun add @arabold/docs-mcp-server`

## README

# 禁用 Docs MCP 服务器

有根据 Docs 给您的 AI 编码助手一个与您使用的库版本相匹配的文档索引 。 它从网站、 GitHub 寄存器、 npm、 PyPI 和本地文件夹取取来文档, 并服务于对模式背景协议、 命令行和网络用户界面的搜索。 你的助理从文件而不是从它记忆中回答.

它是Context7、Nia和Ref的开源替代品。 工具 来.

![Docs MCP Server web interface](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/docs-mcp-server.png)

## 特征

-   索引网站, GitHub 寄存器, npm 和 PyPI 包, 本地文件夹和档案( ZIP, TAR).
-   阅读HTML,Markdown,PDF,Office和OpenDocument文件,EPUB,Jupyter笔记本,源代码等. 见 [支持的格式](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/concepts/supported-formats.md)。 。 。 .
-   将每个库版本分开存储, 因此一个搜索目标为您项目使用的版本 .
-   通过OpenAI,Ollama,双子座,Vertex AI,AWS Bedrock,Azure OpenAI或任何OpenAI相容服务器,将全文搜索与可选向量搜索结合起来.
-   在您的机器上运行并将其索引保存在本地的 SQLite 数据库中 。 文档文本只发送给您配置的嵌入提供者; 带有本地文本, 如 Ollama, 它会留在您的机器上 。 默认使用遥测; [遥测](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/infrastructure/telemetry.md) 列出它发送的信息以及如何关闭.
-   与任何 MCP 客户端一起工作,过 Stdio 或 流式 HTTP.

## 快速启动

你需要Node.js 22或以后,或多克. [安装](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/setup/installation.md) 与 Docker 编曲一起详细覆盖,并在您的AI客户端内运行服务器.

### 1\. 启动服务器

```bash
npx @arabold/docs-mcp-server@latest
```

或与道克相会:

```bash
docker run --rm \
  -v docs-mcp-data:/data \
  -v docs-mcp-config:/config \
  -p 6280:6280 \
  ghcr.io/arabold/docs-mcp-server:latest
```

### 2\. 启动矢量搜索(可选)

没有嵌入模型,搜索使用全文匹配. 矢量搜索也从意义上找到段落. 要使用 OpenAI ,请启动服务器 `OPENAI_API_KEY` 设定 :

```bash
OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest
```

与 Docker 一起添加 `-e OPENAI_API_KEY="sk-proj-..."`。 。 。 . [嵌入模型](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/embedding-models.md) 覆盖奥拉马,双子座,阿苏雷·奥普奈等供应商.

在添加文档前这样做 。 当一个页面被索引时会计算嵌入,所以没有模型索引的文档不会获得向量,直到你再次刮去它 `--replace`。 。 。 .

### 3\. 增加文件

打开网络用户界面 [http://localhost:6280 (英语)](http://localhost:6280/) 选择 **添加库**。 。 。 .

### 4\. 连接您的AI客户端

添加服务器的 MCP 端点, `http://localhost:6280/mcp`敬你的客户 大多数客户接受这样的条目:

```json
{
  "mcpServers": {
    "docs-mcp-server": {
      "url": "http://localhost:6280/mcp"
    }
  }
}
```

[连接 MCP 客户端](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/mcp-clients.md) 拥有Claude Code, Claude Desktop, Zed 等客户端的确切设置,客户端如何在 stdio 上启动服务器本身,以及 MCP 工具列表.

## 命令行

CLI索引和搜索没有运行的服务器,它适合脚本和编码代理. 它与同一机器上的服务器共享其数据库.

```bash
# Index documentation
npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react

# Search it
npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml

# Fetch one page as Markdown without indexing it
npx @arabold/docs-mcp-server@latest fetch-url https://react.dev/reference/react/useEffect
```

`scrape` 拒绝已存在的库版本。 过 `--replace` 重建或运行 `refresh` 要更新它的位置。 这个 [`skills/`](https://npmcn.com/package/%40arabold/docs-mcp-server/skills/) 目录有代理技能,用于教授这些命令的编码代理. [基本用途](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/basic-usage.md) 覆盖每个命令,输出格式和本地文件.

## 网络搜索

-   在它爬上一个网站之前,一个刮去或刷新寻找一个 `llms.txt` 文件在起始 URL 目录和站点根中。 这里列出的链接成为额外的起点,对于这些页面,刮取器首先尝试了Markdown版本的URL,例如: `/guide/index.html.md` 或者说 `/page.html.md`。 。 。 .
-   请求像浏览器一样,先要求 HTML 。 标记为服务器在请求中转换时会忽略网站的导航,所以爬行会错过大多数页面. 刮刮机使用网站所刊登的Markdown: `llms.txt` 和链接 `.md` 文档。 习惯 `Accept` 页眉替换默认的页眉 .
-   对于带散列 URL 路径的文档站点,例如 `https://docs.example.com/#/guide`打开散列路线 见 [Hash 路线行为](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/setup/configuration.md#hash-route-behavior)。 。 。 .

## 文档

设置 :

-   [安装](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/setup/installation.md): npx, Docker, Docker 编译和嵌入式服务器.
-   [配置](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/setup/configuration.md): 配置文件,环境变量和每个设置.
-   [嵌入模型](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/embedding-models.md):提供商,模型和改变模型.

用法 :

-   [基本用途](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/basic-usage.md):web UI,CLI和本地文件.
-   [连接 MCP 客户端](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/mcp-clients.md):客户端设置和MCP工具.
-   [支持的格式](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/concepts/supported-formats.md): 文件格式和每个格式的处理方式.
-   [搜索质量基准](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/guides/benchmarking.md): 测量检索质量.

部署:

-   [部署模式](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/infrastructure/deployment-modes.md):一个过程,或拥有单独的MCP和网络服务的工人.
-   [反向代理部署](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/infrastructure/reverse-proxy.md): 在如下路径下为服务器服务: `https://example.com/docs`。 。 。 .
-   [认证](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/infrastructure/authentication.md):用OAuth2/OIDC保护MCP端点.
-   [警卫](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/infrastructure/security.md):信任界限和对刮刮机可能达到的限度.
-   [遥测](https://npmcn.com/package/%40arabold/docs-mcp-server/docs/infrastructure/telemetry.md):服务器发送的用法事件,以及如何关闭.

内部 :

-   [建筑](https://npmcn.com/package/%40arabold/docs-mcp-server/ARCHITECTURE.md):供稿人的系统设计.

## 捐款

见 [捐款额](https://npmcn.com/package/%40arabold/docs-mcp-server/CONTRIBUTING.md) (c) 发展结构和准则.

## 许可证

这个项目根据麻省理工学院的许可证获得许可。 见 [自由主义](https://npmcn.com/package/%40arabold/docs-mcp-server/LICENSE) 详细情况.

## 常见问题

### @arabold/docs-mcp-server 是什么？

用于获取和搜索文档的 MCP 服务器

### 如何安装 @arabold/docs-mcp-server？

在项目目录运行 npm install @arabold/docs-mcp-server，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 docs-mcp-server，可以用 npx docs-mcp-server 直接运行。

### @arabold/docs-mcp-server 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/arabold\_\_docs-mcp-server 是否存在。

### @arabold/docs-mcp-server 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @arabold/docs-mcp-server 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @arabold/docs-mcp-server 可以商用吗？

@arabold/docs-mcp-server 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @arabold/docs-mcp-server 的下载量有多少？

根据 npm 官方下载统计，@arabold/docs-mcp-server 在 2026/10/07 – 2026/11/05 这 30 天内被下载 6,407 次，日均约 214 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @arabold/docs-mcp-server 还在维护吗？

最新版本 3\.4\.1 发布于 2026/10/26（13 天前）；至今共发布 86 个版本，其中过去 12 个月发布了 39 个；首次发布于 2025/03/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。