Ref Tools MCP

🚀 Ref MCP

Ref MCP 是一個 ModelContextProtocol 服務器，它能讓你的 AI 編碼工具或智能體訪問 API、服務、庫等的文檔。這是一種快速且節省令牌的方式，可確保你的智能體始終能獲取到最新的文檔信息。

如需更多信息，請訪問 ref.tools

🚀 快速開始

有兩種方式可將 Ref 設置為 MCP 服務器，你可以選擇通過流式 HTTP 服務器（實驗性）或本地標準輸入輸出服務器。

本倉庫包含舊版的標準輸入輸出服務器。

📦 安裝指南

stdio

"Ref": {
  "command": "npx",
  "args": ["ref-tools-mcp"],
  "env": {
    "REF_API_KEY": <註冊獲取 API 密鑰>
  }
}

Streamable HTTP（實驗性）

"Ref": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote@0.1.0-0",
      "https://api.ref.tools/mcp",
      "--header",
      "x-ref-api-key:<註冊獲取 API 密鑰>"
    ]
  }
}

截至 2025 年 4 月，MCP 支持流式 HTTP 服務器。Ref 實現了這一功能，但並非所有客戶端都支持，因此最可靠的方法是使用 mcp-remote 作為本地代理。如果你知道你的客戶端支持流式 HTTP 服務器，可以直接使用 https://api.ref.tools/mcp。

⚠️ 重要提示

原 Alpha 版本用戶請注意：仍然支持 REF_ALPHA 配置。如果需要更新，系統會通知你。

✨ 主要特性

Ref MCP 服務器為你的智能體提供了所有與文檔相關的工具。

ref_search_documentation

這是一個強大的搜索工具，用於查詢技術文檔。當你需要任何技術平臺、框架、API、服務、數據庫或庫的信息時，都可以使用此工具。它會在相關文檔中進行搜索，精確找到你需要的內容，甚至可以定位到頁面的具體部分。

ref_read_url

該工具用於讀取網頁的完整內容。這使得你的智能體能夠跟隨文檔和網頁搜索中的鏈接。

ref_search_web（可選）

當 ref_search_documentation 無法找到你需要的信息時，這是一個備用的網頁搜索工具。它會在網頁上找到相關頁面的鏈接，你可以使用 ref_read_url 工具讀取相關頁面的內容。

💡 使用建議

我們提供這個工具是為了讓 Ref 在一個 MCP 服務器中滿足你所有的搜索需求，但如果你更喜歡其他搜索提供商，可以通過將 DISABLE_SEARCH_WEB 環境變量設置為 true，或者在流式 HTTP 服務器中設置 disable_search_web=false URL 參數來禁用 ref_search_web。

💻 使用示例

開發環境搭建

npm install
npm run dev

使用 Inspector 運行

出於開發和調試目的，你可以使用 MCP Inspector 工具。Inspector 提供了一個可視化界面，用於測試和監控 MCP 服務器的交互。

訪問 Inspector 文檔 獲取詳細的設置說明。

在本地使用 Inspector 進行測試：

npm run inspect

或者同時運行監控器和 Inspector：

npm run dev

本地開發

1. 克隆倉庫
2. 安裝依賴：

npm install

3. 構建項目：

npm run build

4. 開發時自動重新構建：

npm run watch

📄 許可證

本項目採用 MIT 許可證。