Documentation for your agent Website License npm version

Ref MCP

一个 ModelContextProtocol 服务器，让您的 AI 编码工具或代理能够访问 API、服务、库等的文档。它是您的一站式解决方案，以快速且节省 token 的方式让您的代理随时掌握最新文档。

更多信息请访问 ref.tools

为精准上下文提供的代理搜索

Ref 的工具旨在匹配模型的搜索方式，同时尽可能少地使用上下文，以减少上下文腐烂 (context rot)。其目标是在使用最少 token 的同时，准确找到您的编码代理成功所需的上下文。

根据提示词的复杂程度，像 Claude Code 这样的 LLM 编码代理通常会进行一次或多次搜索，然后选择一些资源进行深入阅读。

对于关于 Figma Comment REST API 的简单查询，它会进行几次调用以获取所需内容：

SEARCH 'Figma API post comment endpoint documentation' (54 tokens)
READ https://www.figma.com/developers/api#post-comments-endpoint (385 tokens)

对于更复杂的情况，LLM 会在阅读结果时尝试优化其提示词。例如：

SEARCH 'n8n merge node vs Code node multiple inputs best practices' (126)
READ https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#merge (4961)
READ https://docs.n8n.io/flow-logic/merging/#merge-data-from-multiple-node-executions (138)
SEARCH 'n8n Code node multiple inputs best practices when to use' (107)
READ https://docs.n8n.io/code/code-node/#usage (80)
SEARCH 'n8n Code node access multiple inputs from different nodes' (370)
SEARCH 'n8n Code node $input access multiple node inputs' (372)
READ https://docs.n8n.io/code/builtin/output-other-nodes/#output-of-other-nodes (2310)

Ref 利用 MCP 会话来跟踪搜索轨迹并最小化上下文使用。还有很多想法正在酝酿中，但以下是我们目前已经实现的功能。

1. 过滤搜索结果

对于会话中重复的类似搜索，Ref 永远不会返回重复的结果。传统上，您通过翻页到下一个结果来深入挖掘搜索结果，但这种方法允许代理在翻页的同时调整提示词。

2. 获取页面中重要的部分

在阅读文档页面时，Ref 将使用代理的会话搜索历史记录来剔除不太相关的部分，并返回最相关的 5k 个 token。这有助于 Ref 避免标准 fetch() 网络抓取的一个大问题，即当它访问大型文档页面时，很容易最终将 20k+ 个 token 拉入上下文，而其中大部分是不相关的。

Related MCP server: Firebase Realtime Database

为什么最小化文档上下文的 token 很重要？

1. 更多的上下文会让模型变笨

有充分的文献证明，截至 2025 年 7 月，随着您输入的 token 增加，模型会变得更笨。您可能听说过模型现在非常擅长处理长上下文，这在某种程度上是真的，但并非全貌。有关一些研究的快速入门，请观看 Chroma 团队的这段视频。

2. Token 需要 $$$

想象一下，您正在使用 Claude Opus 作为后台代理，您首先让代理拉取文档上下文，假设它拉取了 10000 个 token 的上下文，其中 4000 个是相关的，6000 个是额外的噪音。按照 API 定价，那 6k 个 token 每步大约花费 $0.09。如果一个提示词最终需要 11 步才能完成，那么您就白白花费了 $1。

设置

有两种设置 Ref 作为 MCP 服务器的选项，即通过 streamable-http 服务器（推荐）或本地 stdio 服务器（旧版）。

此仓库包含旧版 stdio 服务器。

Streamable HTTP（推荐）

Install Ref MCP in Cursor

"Ref": {
  "type": "http",
  "url": "https://api.ref.tools/mcp?apiKey=YOUR_API_KEY"
}

stdio

Install Ref MCP in Cursor (stdio)

"Ref": {
  "command": "npx",
  "args": ["ref-tools-mcp@latest"],
  "env": {
    "REF_API_KEY": <sign up to get an api key>
  }
}

工具

Ref MCP 服务器为您代理的需求提供了所有与文档相关的工具。

ref_search_documentation

一个强大的搜索工具，用于检查技术文档。非常适合查找事实或代码片段。也可用于搜索网络上的公共文档或 GitHub，以及来自仓库和 PDF 等私有资源的文档。

参数：

query（必需）：用于搜索相关文档的查询。这应该是一个完整的句子或问题。

ref_read_url

一个从 URL 获取内容并将其转换为 Markdown 以便使用 Ref 轻松阅读的工具。当与返回相关内容 URL 的 ref_search_documentation 工具结合使用时，此工具非常强大。

参数：

url（必需）：要阅读的网页 URL。

OpenAI 深度研究支持

Ref 可用作深度研究的来源。OpenAI 需要特定的工具定义，因此当与 OpenAI 客户端一起使用时，Ref 将提供名称略有不同的相同工具。

ref_search_documentation(query) -> search(query)
ref_read_url(url) -> fetch(id)

开发

npm install
npm run dev

使用 Inspector 运行

出于开发和调试目的，您可以使用 MCP Inspector 工具。Inspector 为测试和监控 MCP 服务器交互提供了一个可视化界面。

访问 Inspector 文档获取详细的设置说明。

要使用 Inspector 在本地进行测试：

npm run inspect

或者同时运行 watcher 和 inspector：

npm run dev

本地开发

克隆仓库
安装依赖：

npm install

构建项目：

npm run build

进行自动重建的开发：

npm run watch

许可证

MIT

Ref