Ref MCP
为编程助手按需检索并提取技术文档,减少无关上下文。
- Star 数
- ★ 1.2k
- 最近更新
- 2 天前
- License
- MIT
- 主语言
- TypeScript
- FA 评分
- 54/100 · 缺口较多
30 秒速览
- 运行形态
- 可在哪里用
- 通用 · 跨平台OpenAI API
- 费用
- 有免费版,另有付费云服务
- 上手难度
- 低 · 几分钟可跑通
- 开始前需要
- 典型场景
- 使用 Claude Code 的开发者需要查询 Figma Comment REST API 的具体端点时,可先搜索再读取对应文档页面。
- 不适合
- 需要完全离线或数据不出本地的团队
- 不愿注册 Ref 账号并获取 API key 的用户
- 需要明确价格、配额与可用性承诺的团队
- 源码审查
- 54/100 · 缺口较多
这个 Agent 能做什么,适合哪些场景?
Ref MCP 是一个 Model Context Protocol(MCP)服务器,为 AI 编程工具提供 API、服务和库的文档访问能力。它提供推荐的 Streamable HTTP 服务,也保留本地 stdio 服务模式。服务器包含 ref_search_documentation 和 ref_read_url 两个文档工具,前者搜索公开网页、GitHub 以及所述的私有资源,后者将指定网页转换为 Markdown。它利用 MCP 会话中的搜索轨迹避免在相似查询中重复返回结果,并在读取文档时保留最相关的最多约 5,000 个 token。仓库还说明了面向 OpenAI deep research 客户端的 search 与 fetch 工具命名映射。
编程助手先调用 ref_search_documentation(query),以完整句子或问题搜索相关技术文档;该工具返回可继续读取的文档结果。随后助手调用 ref_read_url(url),服务器获取该网页并转换成 Markdown;读取时会参考当前 MCP 会话的搜索历史,过滤相关性较低的页面段落并返回最相关的内容。对于重复的相近搜索,服务器不重复返回已有结果。通过 OpenAI 客户端使用时,ref_search_documentation(query) 映射为 search(query),ref_read_url(url) 映射为 fetch(id)。
- 使用 Claude Code 的开发者需要查询 Figma Comment REST API 的具体端点时,可先搜索再读取对应文档页面。
- 维护 n8n 工作流的工程师需要比较 Merge 节点和 Code 节点的多输入处理方式时,可连续搜索并读取多个相关章节。
- 将 MCP 工具接入支持 Streamable HTTP 的编程环境的团队,需要让编码助手按需读取 API、服务或库文档时。
- 需要通过 npx 在本机以 stdio 方式运行文档工具的开发者,可将其配置为本地 MCP 服务器。
- 通过 OpenAI 客户端开展 deep research 的用户,需要以 search 和 fetch 形式调用同一套文档检索与读取能力时。
如何安装或部署这个 Agent?
推荐使用 Streamable HTTP 配置,并先注册获取 Ref API key:
"Ref": {
"type": "http",
"url": "https://api.ref.tools/mcp?apiKey=YOUR_API_KEY"
}
本地 stdio 模式可配置为:
"Ref": {
"command": "npx",
"args": ["ref-tools-mcp@latest"],
"env": {
"REF_API_KEY": "<sign up to get an api key>"
}
}
本地开发仓库时可运行 npm install,然后 npm run build;开发自动重建可运行 npm run watch。
如何使用这个 Agent?
配置完成后,在 MCP 客户端调用 ref_search_documentation,并提供必填的 query,例如“Figma API post comment endpoint documentation”。从搜索结果中选择 URL,再调用 ref_read_url,并提供必填的 url。若通过 OpenAI 客户端使用 deep research 工具定义,则调用 search(query) 和 fetch(id)。
这个 Agent 有哪些优点和局限?
- 通过 MCP 会话搜索轨迹抑制相似查询的重复结果。
- 读取页面时会依据搜索历史过滤不相关章节,并将返回内容控制在最相关的约 5,000 个 token。
- 同时提供推荐的 Streamable HTTP 接入和遗留的本地 stdio 接入。
- 针对 OpenAI deep research 提供明确的 search/fetch 命名映射。
- 使用 HTTP 或 stdio 配置都需要注册并提供 Ref API key。
- 仓库将 stdio 服务标为 legacy,采用该模式的用户需承担迁移到 HTTP 模式的可能性。
- 私有仓库和 PDF 的搜索虽被提及,但仓库未说明授权配置、支持范围或访问控制细节。
- 仓库未提供定价、配额、可用性或失败重试策略的说明。
这个 Agent 与同类方案有什么区别?
仓库将其读取策略与标准 fetch() 网页抓取对比:后者在大型文档页上可能把 20,000+ token 带入上下文;Ref 说明会按会话搜索历史筛选相关章节,并返回最相关的约 5,000 个 token。
与相关度最高的同类 agent 并排比较关键指标。
| Agent | 源码审查 | 形态 / 费用 | Star | 最近更新 | 主语言 | 完整支持的平台 |
|---|---|---|---|---|---|---|
| Ref MCP 当前 | 54 · 缺口较多 | MCP 服务器免费版 + 付费版 | ★ 1.2k | 2 天前 | TypeScript | OpenAI API |
| pg-aiguide:PostgreSQL 智能助手 | 53 · 缺口较多 | 命令行工具免费 | ★ 1.9k | 2 天前 | Python | ChatGPT · Codex · Claude Code |
| Grounded Docs MCP 服务器 | 78 · 表现良好 | 命令行工具免费 + 模型费 | ★ 1.9k | 7 天前 | TypeScript | ChatGPT · Claude Code |
| Agentor 智能体开发框架 | 56 · 缺口较多 | 代码库 / SDK免费 + 模型费 | ★ 214 | 11 天前 | Python | OpenAI API |
FollowAgents 如何评估这个 Agent?
查看各维度的扣分理由
产品提供搜索和 URL 阅读两个只读工具,并说明可搜索公开或私有文档;这支持常规使用下的最小权限和数据流可见性。README 说明需要 Ref API key,也展示了通过环境变量配置,但没有说明密钥的存储、轮换或私有资料处理细节,因此敏感数据处理仅部分充分。搜索会调用 Ref 服务,读取工具接受 URL;源码样本未展示对外部副作用的确认、回滚机制或来源归属核验,故这些方面扣分。
README 描述了基于会话搜索历史筛选结果,源码声明支持 stdio 和 HTTP,并在缺少 API key 时返回配置提示;但文档将 HTTP 列为推荐方式,同时称本仓库是 legacy stdio server,形成定位不一致。依赖与服务可用性没有在材料中保证,错误处理证据有限,因此各项未获高分。
README 面向使用编码代理查阅 API、服务和库文档的场景,列出搜索及读取工具和 OpenAI 深度研究工具名映射。源码提供公开与私有文档提示、stdio/HTTP 传输及按客户端选择工具名。材料没有详尽列出不支持的情况或环境要求,故受众和边界虽清楚但不完整。
README 按用途、工具、安装和开发组织,并给出 Cursor、stdio、开发及 Inspector 示例;package.json 提供稳定包名与版本,仓库也附有完整 MIT 许可证。已知限制说明较少;材料未提供变更日志,且维护负责人或更新责任仅能从名称和邮箱线索推知,不能视为明确承诺。
工具设计聚焦文档搜索与按 URL 读取,README 给出减少重复结果、筛选相关页面内容和降低上下文用量的使用说明,并提供调用示例,显示对编码代理有明确的实用价值。效益论据主要是产品说明和示例,未见静态材料证明准确性或实际节省幅度,因此价值与成本效益评分保持适中。
工具定义、包版本、安装配置和许可证可在 README、源码及清单之间相互对照,支持部分交叉核验。减少 token、改善模型表现等主张主要由 README 陈述,样本未给出对应测量方法或结果;事实与推断的区分也不够系统,因此可追溯性和论据强度有限。
- README 同时推荐 HTTP 并称本仓库为 legacy stdio server;部署前应核对所选传输方式与服务端配置。
- 使用私有文档功能时,源码样本未说明 Ref 服务端的数据保留、访问控制或 API key 生命周期细节。
常见问题
需要凭据吗?
它能访问哪些内容?
能否在本地运行?
费用和调用限制是什么?
谢谢反馈,我们会据此改进页面。