/ 目錄 / 演練場 / ref-tools-mcp
● 社群 ref-tools ⚡ 即開即用

ref-tools-mcp

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

幫助編碼代理快速找到正確的文件 — 公開函式庫、私有倉庫、內部 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

如何防止代理編造函式庫 API

👤 編碼代理使用者 ⏱ ~10 min beginner

何時使用: 代理自信地寫出與目前函式庫版本不符的程式碼時。

前置條件
  • Ref 帳戶 + REF_API_KEY — 在 ref.tools 註冊(或任何目前 Ref 的註冊 URL)
步驟
  1. 提出以文件為基礎的問題
    使用 ref_search_documentation 找出如何在 v5 中使用 Prisma 原生 SQL 查詢,然後寫一個範例。✓ 已複製
    → 搜尋結果含有 URL;程式碼引用它們
  2. 驗證
    在頂部結果上使用 ref_read_url 來確認 API 形狀。✓ 已複製
    → 文件頁面的乾淨 markdown

結果: 針對實際函式庫版本編譯的程式碼。

注意事項
  • 搜尋回傳已棄用版本 v-X 的過時文件 — 在查詢中包含版本:'Prisma v5 raw SQL'
搭配使用: github

如何用代理搜尋內部工程文件 / PDF

👤 具有內部工作手冊的平台團隊 ⏱ ~15 min intermediate

何時使用: 代理需要遵循公司特定的模式,而不是 StackOverflow 說的任何東西。

前置條件
  • Ref 私有資源已索引 — 上傳倉庫/PDF 到你的 Ref 工作區(見 Ref 文件)
步驟
  1. 將搜尋範圍限制為私有
    ref_search_documentation '內部驗證模式' 只用私有資源。✓ 已複製
    → 僅內部結果
  2. 閱讀工作手冊
    在頂部內部結果上使用 ref_read_url。✓ 已複製
    → 工作手冊的乾淨文字

結果: 符合內部標準的輸出。

注意事項
  • 內部文件變舊 — 代理仍然引用它們 — 告訴代理檢查 'last updated' 中繼資料並標記舊內容

如何擷取任意 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 呼叫
ref_read_url url: str 拉取頁面作為乾淨的 markdown 1 Ref API 呼叫

成本與限制

運行它的成本

API 配額
根據 Ref 方案層級
每次呼叫 Token 數
搜尋結果:500-2000 tokens。URL 讀取:可能是 5k-20k
費用
Ref 是付費服務(提供免費層級);檢查目前定價
提示
先搜尋,然後只讀取頂部結果 — 連鎖讀取很昂貴。

安全

權限、密鑰、影響範圍

最小權限: REF_API_KEY 儲存在環境變數中
憑證儲存: REF_API_KEY 環境變數
資料出站: 查詢傳送到 Ref 的服務;它反過來存取公開網路和你的已索引私有資源
切勿授予: 不要廣泛分享你的工作區金鑰;如果 Ref 支援,使用按使用者的金鑰

故障排查

常見錯誤與修復

401 未授權

缺少或無效的 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