项目简介

Ref MCP 服务器是基于 Model Context Protocol (MCP) 构建的应用后端，旨在为大型语言模型 (LLM) 客户端或AI代理提供访问技术文档和网页内容的能力。它通过标准化的MCP接口，将外部知识服务（由 'ref.tools' 提供）集成到AI的工作流程中，帮助AI代理获取实时、相关的上下文信息。

主要功能点

该服务器提供了以下核心功能作为AI代理可调用的工具：

搜索技术文档 ('ref_search_documentation')：这是一个强大的工具，用于检索各种技术平台、框架、API、服务、数据库或库的文档。AI代理应优先使用此工具来获取准确的技术信息。
读取网页内容 ('ref_read')：允许AI代理获取指定URL的完整网页内容，并转换为Markdown格式，方便代理阅读和理解。可用于进一步分析文档链接或搜索结果中的网页。
网页搜索 ('ref_search_web')：作为一个补充，在技术文档搜索未找到所需信息时，提供网页搜索能力。AI代理可以使用此工具查找相关的网页链接，再结合“读取网页内容”工具获取详细信息。此功能可以配置禁用。

安装步骤

要运行本地的 Ref MCP 服务器 (Stdio 版本)，您需要 Node.js 环境。请按照以下步骤操作：

从GitHub克隆仓库到您的本地计算机。
打开终端，进入仓库目录。
安装项目依赖：
```
npm install
```
构建项目：
```
npm run build
```
这将生成可执行的服务器文件。

服务器配置

Ref MCP 服务器通过标准输入/输出 (Stdio) 与 MCP 客户端通信。AI代理所使用的MCP客户端需要进行配置才能连接到此服务器。典型的MCP客户端配置是一个JSON对象，包含服务器名称、启动命令和参数等信息。

配置示例（请在您的MCP客户端中按其要求进行配置）：

服务器名称 (Server Name): 例如设置为 "Ref"。
命令 (command): 'npx'
参数 (args): '["ref-tools-mcp"]'
环境变量 (env):
- 'REF_API_KEY': 必需。您需要从 'ref.tools' 网站注册并获取API Key。请将您的API Key 设置为该环境变量的值。
- 'REF_ALPHA': (面向旧版本用户) 如果您是之前的Alpha用户，此配置可能仍然有效，具体请参照 'ref.tools' 的说明。
- 'DISABLE_SEARCH_WEB': (可选) 设置为 '"true"' 可以禁用网页搜索 ('ref_search_web') 工具。

请将上述信息配置到您的MCP客户端软件中对应的服务器设置项里。

基本使用方法

配置完成后，当AI代理通过兼容的MCP客户端连接到 Ref MCP 服务器时，它就可以发现并调用服务器提供的工具。

AI代理可以请求列出服务器提供的工具列表，获取工具的名称、描述和输入参数规范。
根据用户的需求或其内部逻辑，AI代理可以选择调用特定的工具（如 'ref_search_documentation' 或 'ref_read'），并按照工具的输入规范提供相应的参数（如搜索查询或URL）。
MCP 服务器将接收到工具调用请求，执行相应的操作（例如调用 'ref.tools' 提供的API），并将结果通过MCP协议返回给客户端，最终呈现给AI代理，供其生成响应。

通过这种方式，AI代理可以借助 Ref MCP 服务器，高效地访问并利用丰富的外部技术文档和网页信息。

关键词

信息