禁用 Docs MCP 服务器
有根据 Docs 给您的 AI 编码助手一个与您使用的库版本相匹配的文档索引 。 它从网站、 GitHub 寄存器、 npm、 PyPI 和本地文件夹取取来文档, 并服务于对模式背景协议、 命令行和网络用户界面的搜索。 你的助理从文件而不是从它记忆中回答.
它是Context7、Nia和Ref的开源替代品。 工具 来.
特征
- 索引网站, GitHub 寄存器, npm 和 PyPI 包, 本地文件夹和档案( ZIP, TAR).
- 阅读HTML,Markdown,PDF,Office和OpenDocument文件,EPUB,Jupyter笔记本,源代码等. 见 支持的格式。 。 。 .
- 将每个库版本分开存储, 因此一个搜索目标为您项目使用的版本 .
- 通过OpenAI,Ollama,双子座,Vertex AI,AWS Bedrock,Azure OpenAI或任何OpenAI相容服务器,将全文搜索与可选向量搜索结合起来.
- 在您的机器上运行并将其索引保存在本地的 SQLite 数据库中 。 文档文本只发送给您配置的嵌入提供者; 带有本地文本, 如 Ollama, 它会留在您的机器上 。 默认使用遥测; 遥测 列出它发送的信息以及如何关闭.
- 与任何 MCP 客户端一起工作,过 Stdio 或 流式 HTTP.
快速启动
你需要Node.js 22或以后,或多克. 安装 与 Docker 编曲一起详细覆盖,并在您的AI客户端内运行服务器.
1. 启动服务器
npx @arabold/docs-mcp-server@latest
或与道克相会:
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 设定 :
OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest
与 Docker 一起添加 -e OPENAI_API_KEY="sk-proj-..."。 。 。 . 嵌入模型 覆盖奥拉马,双子座,阿苏雷·奥普奈等供应商.
在添加文档前这样做 。 当一个页面被索引时会计算嵌入,所以没有模型索引的文档不会获得向量,直到你再次刮去它 --replace。 。 。 .
3. 增加文件
打开网络用户界面 http://localhost:6280 (英语) 选择 添加库。 。 。 .
4. 连接您的AI客户端
添加服务器的 MCP 端点, http://localhost:6280/mcp敬你的客户 大多数客户接受这样的条目:
{
"mcpServers": {
"docs-mcp-server": {
"url": "http://localhost:6280/mcp"
}
}
}
连接 MCP 客户端 拥有Claude Code, Claude Desktop, Zed 等客户端的确切设置,客户端如何在 stdio 上启动服务器本身,以及 MCP 工具列表.
命令行
CLI索引和搜索没有运行的服务器,它适合脚本和编码代理. 它与同一机器上的服务器共享其数据库.
# 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/ 目录有代理技能,用于教授这些命令的编码代理. 基本用途 覆盖每个命令,输出格式和本地文件.
网络搜索
- 在它爬上一个网站之前,一个刮去或刷新寻找一个
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 路线行为。 。 。 .
文档
设置 :
用法 :
- 基本用途:web UI,CLI和本地文件.
- 连接 MCP 客户端:客户端设置和MCP工具.
- 支持的格式: 文件格式和每个格式的处理方式.
- 搜索质量基准: 测量检索质量.
部署:
- 部署模式:一个过程,或拥有单独的MCP和网络服务的工人.
- 反向代理部署: 在如下路径下为服务器服务:
https://example.com/docs。 。 。 . - 认证:用OAuth2/OIDC保护MCP端点.
- 警卫:信任界限和对刮刮机可能达到的限度.
- 遥测:服务器发送的用法事件,以及如何关闭.
内部 :
- 建筑:供稿人的系统设计.
捐款
见 捐款额 (c) 发展结构和准则.
许可证
这个项目根据麻省理工学院的许可证获得许可。 见 自由主义 详细情况.