← 返回目录

Ref MCP

社区

为编码代理高效检索文档。

查看安装方法 ↓ 横向对比 GitHub 源仓库 ↗

分类: 开发工具第 192 / 438
Stars: ★ 1.2k 非常热门
传输方式: Streamable HTTP · stdio（本地进程）
运行环境: Node.js · 远程托管（无需本地环境）
凭据: 需要 API Key / 凭据
许可证: MIT
最近提交: 23 天前
工具数: 2

55FMRS · C

资料显示，Ref MCP 专注于面向编码代理的令牌高效文档搜索和 URL 内容读取，支持 Streamable HTTP 与传统 stdio，并需要 API 密钥。

最强项 · 文档质量 14/20 最弱项 · 安全与权限 8/20

可靠性

9/20

安全与权限

8/20

维护活跃度

11/20

文档质量

14/20

安装易用性

13/20

查看各项评分依据

可靠性 9/20: README明确描述了两个工具及其参数，manifest提供了可连接的Streamable HTTP端点，因此正常路径看起来可行。但未提供已提交的测试、CI、初始化或工具列表握手证据，也未说明错误处理、超时、依赖失败和边界情况；manifest未声明工具，且README同时描述远程与遗留stdio实现，故保守扣分。
安全与权限 8/20: manifest要求使用标记为秘密的API key请求头，体现了基本认证边界；工具主要进行文档搜索和读取，未显示写入或破坏性操作。但README还展示了将API key放入URL查询参数的配置方式，可能造成日志或历史记录泄露；私有仓库、PDF和外部URL的数据边界、保留策略、最小权限和危险请求确认均未说明，因此扣分。
维护活跃度 11/20: 仓库未归档，标注MIT许可证，manifest版本为3.0.1，且有5个开放问题，说明存在可识别的维护与授权基础。但仅凭给定材料没有提交历史、发布频率、依赖更新、问题响应、维护者身份或安全响应渠道证据，无法按持续维护标准给高分。
文档质量 14/20: README覆盖用途、两种安装方式、认证示例、两个工具及其必需参数，并提供了搜索与读取示例、开发和Inspector说明。扣分原因是manifest没有声明工具，远程认证方式与README中的URL参数方式存在不一致；平台兼容性、配额、定价、隐私/数据处理、错误排查和服务限制披露不足。
安装易用性 13/20: README提供了Cursor链接、Streamable HTTP配置和stdio配置，并给出npx命令及API key位置，主流客户端的基本连接步骤较清楚。但需要先获取API key，远程配置存在请求头与URL参数两种不一致方式，stdio被标为legacy，且未提供更广泛的平台兼容性或连接失败排查证据，因此未接近满分。

静态评测 · 未实际运行收录于 2026-07-29

查看 FMRS 评分方法 →

选型与风险

能访问什么访问网络

适合谁

需要快速查阅技术文档的 AI 编码代理
希望减少无关文档上下文和令牌消耗的团队
需要访问公共及已授权私有文档资源的用户

不适合谁

不需要文档检索能力的 MCP 客户端工作流
没有 Ref API 密钥的用户
需要通用网页抓取而非文档搜索和读取的场景

所需权限

需要 Ref API 密钥进行身份验证
使用私有资源时，需要相应私有资源的访问授权

风险与副作用

API 密钥属于机密凭据，应避免暴露或提交到共享配置中
检索私有仓库和 PDF 时，代理可能接触这些资源中的内容
页面内容会作为代理上下文输入，结果仍需结合任务进行核验

安装接入

准备工作

运行环境：Node.js · 远程托管（无需本地环境）

REF_API_KEY 必填密钥 Ref 的 API 密钥，用于调用文档搜索服务，需在 ref.tools 注册获取。

推荐使用 Streamable HTTP：连接 https://api.ref.tools/mcp，并提供 API 密钥；也可使用传统 stdio：运行 npx ref-tools-mcp@latest，并通过 REF_API_KEY 环境变量提供 API 密钥。

.cursor/mcp.json

{"Ref":{"command":"npx","args":["ref-tools-mcp@latest"],"env":{"REF_API_KEY":"YOUR_API_KEY"}}}

以 Cursor 为例。其他客户端的配置文件位置或字段可能不同（如 VS Code 使用 servers 字段），可用下方配置生成器转换。

.vscode/mcp.json

{
  "Ref": {
    "command": "npx",
    "args": [
      "ref-tools-mcp@latest"
    ],
    "env": {
      "REF_API_KEY": "YOUR_API_KEY"
    }
  }
}

写入项目的 .vscode/mcp.json（VS Code 使用 servers 字段）。

生成并校验客户端配置

验证是否装好

在客户端工具列表中确认出现 ref_search_documentation 和 ref_read_url 两个工具，然后让 agent 搜索一个简单的 API 问题，若能返回带 token 数的搜索结果与文档 URL，说明连接成功。

常见排障

确认 API 密钥有效且已通过 X-Ref-Api-Key、URL 参数或 REF_API_KEY 提供
使用 Streamable HTTP 时检查 https://api.ref.tools/mcp 地址和认证配置
使用 stdio 时确认 npx 可用并安装 ref-tools-mcp@latest
若读取内容不符合预期，先使用 ref_search_documentation 获取相关 URL，再调用 ref_read_url

试试这样问

连接成功后，可以直接对 AI 助手这样说：

帮我查一下 Figma 的 Comment REST API 如何发布评论，并给出文档链接。
搜索 n8n 中 merge 节点与 Code 节点处理多个输入的最佳实践。
读取 https://docs.n8n.io/code/code-node/ 这个页面，总结 Usage 部分的内容。

工具能力 2

ref_search_documentation 只读

搜索技术文档，可查找公共网页、GitHub 内容以及私有仓库和 PDF 中的相关事实或代码片段。

ref_read_url 只读

获取指定 URL 的内容并转换为 Markdown，适合读取搜索结果中的相关文档页面。

使用场景

为编码代理查找 API、服务和库的技术文档

先搜索相关文档，再读取特定页面内容

从公共或私有资源中检索事实和代码片段

支持客户端

Cursor

依据项目文档列出，未经本站实测。

详细介绍

Ref MCP 是一个 Model Context Protocol 服务器，为 AI 编码工具或代理提供公共和私有 API、服务及库文档访问能力。它通过会话搜索轨迹过滤重复结果，并提取页面中最相关的内容，以减少上下文使用。