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 分