Refdocs

io.github.CloudCorpRecords由 GitHub 帳號 CloudCorpRecords 發布v0.1.0更新於 Nov 3, 2026

搜尋技術文件並以Markdown格式閱讀網頁。

AI 翻譯由 AI 模型根據下方的原文描述翻譯，可能有誤。

原文描述

Search technical documentation and read web pages as markdown.

已驗證STDIO僅桌面

概覽

Refdocs 的本機 MCP 服務；無需登入；STDIO。

暫無 AI 概覽：以下資訊來自註冊中心條目和服務本身。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Refdocs，將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only，透過 STDIO。 STDIO 服務會啟動本機處理程序，因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

refdocs

refdocs answers documentation questions and turns web pages into something an agent can actually read. Search runs across public technical documentation and GitHub for the facts or code snippet behind a question, and any URL can be fetched and handed back as clean markdown instead of raw HTML.

It is one small program with two faces: a command-line tool for quick lookups, and a stdio MCP server that gives agents the same two operations as tools.

Configuration

Both operations require a Ref API key:

bash
export REF_API_KEY="your-key-here"

The search endpoint defaults to https://api.ref.tools. Override it with REF_API_BASE_URL when you are pointing at another deployment. The key is checked before any request is made; when it is missing the tool fails with an error that names REF_API_KEY.

Install

bash
npx @reneturcios/refdocs search "How do I stream a response with fetch?"

Or run the container image:

bash
docker run -i -e REF_API_KEY ghcr.io/cloudcorprecords/refdocs

The container defaults to the MCP server (see below). Pass CLI arguments to use it as a CLI instead.

CLI

bash
# Search the documentationrefdocs search "How do I use the cache API in Next.js?"refdocs search "What does this error mean?" --json
# Read a page as markdownrefdocs read https://example.test/some/guiderefdocs read https://example.test/some/guide --json
# Check the configuration without making a requestrefdocs check
refdocs --version

Exit codes: 0 on success, 1 when a lookup fails or the configuration is not ready (the error names the problem), 2 for usage errors.

MCP server

One bin serves both faces. The mcp subcommand starts a stdio MCP server:

bash
npx -y @reneturcios/refdocs mcp

MCP client configuration:

json
{  "mcpServers": {    "refdocs": {      "command": "npx",      "args": ["-y", "@reneturcios/refdocs", "mcp"],      "env": {        "REF_API_KEY": "your-key-here"      }    }  }}

Tools

ToolInputWhat it returns
ref_search_documentationquery (string, required) — a full sentence or question to search forMatching documentation results from public documentation and GitHub, each with its title, URL, and content or snippet when the upstream provides them.
ref_read_urlurl (string, required) — the URL of the webpage to readThe page content converted to markdown: headings, links, lists, emphasis, and code blocks are kept in markdown form, while scripts, styles, and other non-content markup are dropped.

Search responses are parsed tolerantly: a bare array, a results list, and a documents list are all accepted. Reading plain-text URLs returns the text unchanged.

Development

bash
npm installnpm run build   # tsc -> dist/npm test        # node test runner over test/*.test.ts, no networknpm run dev     # run the CLI from source via tsx

Tests run entirely against a fake fetch function; no live API calls are made.

License

MIT — see LICENSE.

來源：README.md，提交 5ec1c08

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包，因此其工具未知。

版本歷史

1
  1. v0.1.0最新Nov 3, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度，依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價，也不表示伺服器安全或目前可用：可連通性是帶日期的檢查結果，評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手；SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭，或保持端點能夠回應探測，以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list，或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分