/ 目录 / 演练场 / ref-tools-mcp
● 社区 ref-tools ⚡ 即开即用

ref-tools-mcp

作者 ref-tools · ref-tools/ref-tools-mcp

帮助编码 Agent 快速找到正确的文档 — 公开库、私有仓库、内部 PDF — 不浪费 context 在错误的页面上。

ref-tools/ref-tools-mcp(由 Ref 开发)提供两个工具:一个跨公网、GitHub 仓库和私有资源的精准文档搜索,以及一个返回 markdown 的 URL 读取工具。需要 REF_API_KEY。

为什么要用

核心特性

实时演示

实际使用效果

ref-tools.replay ▶ 就绪
0/0

安装

选择你的客户端

~/Library/Application Support/Claude/claude_desktop_config.json  · Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "ref-tools": {
      "command": "npx",
      "args": [
        "-y",
        "ref-tools-mcp"
      ],
      "_inferred": true
    }
  }
}

打开 Claude Desktop → Settings → Developer → Edit Config。保存后重启应用。

~/.cursor/mcp.json · .cursor/mcp.json
{
  "mcpServers": {
    "ref-tools": {
      "command": "npx",
      "args": [
        "-y",
        "ref-tools-mcp"
      ],
      "_inferred": true
    }
  }
}

Cursor 使用与 Claude Desktop 相同的 mcpServers 格式。项目级配置优先于全局。

VS Code → Cline → MCP Servers → Edit
{
  "mcpServers": {
    "ref-tools": {
      "command": "npx",
      "args": [
        "-y",
        "ref-tools-mcp"
      ],
      "_inferred": true
    }
  }
}

点击 Cline 侧栏中的 MCP Servers 图标,然后选 "Edit Configuration"。

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "ref-tools": {
      "command": "npx",
      "args": [
        "-y",
        "ref-tools-mcp"
      ],
      "_inferred": true
    }
  }
}

格式与 Claude Desktop 相同。重启 Windsurf 生效。

~/.continue/config.json
{
  "mcpServers": [
    {
      "name": "ref-tools",
      "command": "npx",
      "args": [
        "-y",
        "ref-tools-mcp"
      ]
    }
  ]
}

Continue 使用服务器对象数组,而非映射。

~/.config/zed/settings.json
{
  "context_servers": {
    "ref-tools": {
      "command": {
        "path": "npx",
        "args": [
          "-y",
          "ref-tools-mcp"
        ]
      }
    }
  }
}

加入 context_servers。Zed 保存后热重载。

claude mcp add ref-tools -- npx -y ref-tools-mcp

一行命令搞定。用 claude mcp list 验证,claude mcp remove 卸载。

使用场景

实战用法: ref-tools-mcp

如何防止 Agent 对库 API 产生幻觉

👤 编码 Agent 用户 ⏱ ~10 min beginner

何时使用: Agent 自信地写出与当前库版本不匹配的代码。

前置条件
  • Ref 账户 + REF_API_KEY — 在 ref.tools 注册(或任何当前的 Ref 注册 URL)
步骤
  1. 提一个以文档为基础的问题
    使用 ref_search_documentation 查找如何在 v5 中使用 Prisma 原生 SQL 查询,然后写一个示例。✓ 已复制
    → 搜索结果带有 URL;代码引用它们
  2. 验证
    用 ref_read_url 读取顶部结果以确认 API 签名。✓ 已复制
    → 文档页面的清晰 markdown

结果: 能针对真实库版本编译的代码。

注意事项
  • 搜索返回已弃用版本的过时文档 — 在查询中包含版本号:'Prisma v5 raw SQL'
搭配使用: github

如何用 Agent 搜索内部工程文档 / PDF

👤 拥有内部运维手册的平台团队 ⏱ ~15 min intermediate

何时使用: Agent 需要遵循公司特定的模式,而不是 StackOverflow 上的任意内容。

前置条件
  • Ref 私有源已索引 — 将仓库/PDF 上传到你的 Ref 工作区(参考 Ref 文档)
步骤
  1. 将搜索范围限制在私有源
    使用 ref_search_documentation 搜索 'internal auth pattern',仅限私有源。✓ 已复制
    → 仅返回内部结果
  2. 阅读运维手册
    用 ref_read_url 读取顶部内部结果。✓ 已复制
    → 运维手册的清晰文本

结果: 符合内部标准的输出。

注意事项
  • 内部文档过时 — Agent 仍然引用它们 — 告诉 Agent 检查'最后更新'元数据,并标记过时内容

如何将任意 URL 转换为清晰 markdown

👤 任何进行研究和总结的人 ⏱ ~5 min beginner

何时使用: 你想要文章文本,不要导航/广告/JS 垃圾。

步骤
  1. 读取 URL
    ref_read_url https://some-blog.com/post — 给我清晰的 markdown。✓ 已复制
    → 正文作为 markdown
  2. 总结
    现在给我一个 5 点总结。✓ 已复制
    → 总结

结果: 清晰的内容,快速获得。

搭配使用: markdownify

组合

与其他 MCP 搭配,撬动十倍杠杆

ref-tools + github

用官方文档引用来支撑 PR 审查

对于 PR #1234 中的 Prisma 迁移,使用 ref_search_documentation 验证每个 API 是否与 v5 文档匹配,然后在 PR 上评论。✓ 已复制
ref-tools + markdownify

结合 Ref 的文档搜索和 markdownify 处理 Ref 中未索引的本地 PDF

在 Ref 中搜索我们的内部身份验证指南,然后用 markdownify 处理尚未索引的额外 /specs/auth-v3.pdf。✓ 已复制

工具

此 MCP 暴露的能力

工具输入参数何时调用成本
ref_search_documentation query: str, sources?: str[] 基于库或内部文档回答问题 1 Ref API call
ref_read_url url: str 将页面转换为清晰 markdown 1 Ref API call

成本与限制

运行它的成本

API 配额
按 Ref 计划等级
每次调用 Token 数
搜索结果:500-2000 token。URL 读取:5k-20k
费用
Ref 是付费服务(提供免费版本);查看当前价格
提示
先搜索,然后只读取顶部结果 — 链式读取很昂贵。

安全

权限、密钥、影响范围

最小权限: REF_API_KEY 存储在环境变量中
凭据存储: REF_API_KEY 环境变量
数据出站: 查询发送到 Ref 的服务;它依次访问公网和你索引的私有源
切勿授予: 不要广泛分享你的工作区密钥;如果 Ref 支持,使用每用户密钥

故障排查

常见错误与修复

401 Unauthorized

缺少或无效的 REF_API_KEY。

验证: echo $REF_API_KEY
搜索返回过时结果

私有源重新索引可能延迟;从 Ref 仪表板强制重新索引。

ref_read_url 返回空

某些网站阻止爬取。使用 markdownify 中的 webpage-to-markdown 作为后备方案。

配额超出

升级 Ref 计划或分散搜索使用。

替代方案

ref-tools-mcp 对比其他方案

替代方案何时用它替代权衡
Context7 MCP你想要免费的公开库文档检索没有私有源索引
Apple Docs MCP / pg-aiguide你只关心特定平台的文档范围受限;不是通用工具

更多

资源

📖 阅读 GitHub 上的官方 README

🐙 查看未解决的 issue

🔍 浏览全部 400+ MCP 服务器和 Skills