Redocly

com.redocly由 redocly.com 發布官方發布者v1.0.1更新於 Nov 3, 2026

Search and read the Redocly product docs, guides and blog on redocly.com, and report a wrong page.

已驗證Streamable HTTP可網頁執行知識與記憶開發者工具

概覽

AI 產生的概覽

Redocly 遠端伺服器,讓助理搜尋與閱讀 Redocly 文件及 OpenAPI 參考,並回報有誤的頁面。

可以做什麼
  • 搜尋與閱讀文件:搜尋文件、逐層列出導覽、以 Markdown 分段讀取頁面、依文字找出包含該文字的行。
  • 瀏覽 API:列出可用 API、其端點、端點詳情、安全性配置以及完整的 OpenAPI 描述。
  • 執行沙箱腳本:執行呼叫全域 site 物件上這些函式的 JavaScript,環境中沒有 fetch、console 或 Node.js API。
  • 查詢函式簽章:discover 會回傳沙箱函式的精確 TypeScript 簽章,方便撰寫腳本。
  • 回報問題:針對內容錯誤或不完整的文件頁面送出回饋。
適用情境
適合在回答問題時需要最新的 Redocly 產品文件、CLI 與設定說明或 OpenAPI 參考細節,例如撰寫 lint 規則或建立文件網站。也可用來把文件問題回報給 Redocly 文件團隊。
執行需求
透過 Streamable HTTP 連線到 redocly.com/mcp 的遠端 MCP 端點;未宣告需要安裝套件、帳號或 API 金鑰。用戶端會送出 X-Redocly-MCP-Source 標頭。需要能連線到 redocly.com 的網路。
安裝前請注意
execute 工具會在沙箱中對網站執行 JavaScript,腳本只能使用文件中列出的 site 函式。submit-feedback 會把回報送給 Redocly 文件團隊。Redocly 會收到工具呼叫並保留使用統計,例如工具名稱、耗時、用戶端名稱與外掛版本,但不包含對話內容。

安裝

在 SourceWeft 中

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

Web executable,透過 Streamable HTTP。 遠端服務在工作區中設定後即可從網頁執行環境執行。

交給代理程式安裝

把這段提示詞貼上到 Claude Code、Codex、Cursor 等代理程式,或 SourceWeft 對話中。代理程式會讀取該伺服器的安裝指南,先向你展示發布者、端點和登入方式,經你同意後再把它新增到你的客戶端。金鑰不會寫進任何命令。

閱讀 https://sourceweft.com/mcp/com.redocly%2Fmcp/install.md,並按其中說明把這個 MCP 伺服器接入我的客戶端。修改任何設定之前,先告訴我它的發布者、端點和登入方式,等我確認。不要把 API 金鑰寫進命令或我會提交的檔案;問我金鑰應從哪裡取得。

檢視代理程式所依據的安裝指南

其他 MCP 客戶端

把它新增到你客戶端的 mcpServers 設定中。

{
  "mcpServers": {
    "redocly": {
      "type": "http",
      "url": "https://redocly.com/mcp"
    }
  }
}

README

Redocly plugin

The Redocly plugin gives your AI coding agent the Redocly skills and live access to the Redocly documentation through the Redocly MCP server. It works in Claude Code, Codex and Cursor.

Install

Claude Code:

bash
claude plugin marketplace add Redocly/redocly-pluginclaude plugin install redocly@redocly

Codex:

bash
codex plugin marketplace add Redocly/redocly-plugincodex plugin add redocly@redocly

Cursor: import this repository as a team marketplace (Teams and Enterprise plans), or copy plugins/redocly into ~/.cursor/plugins/local.

Skills only, in any client that reads Agent Skills:

bash
npx skills add Redocly/redocly-plugin

MCP server only, in any MCP client: add https://redocly.com/mcp as a remote server over Streamable HTTP, or install com.redocly/mcp from the MCP Registry. The Redocly MCP server docs have the steps for each client.

What you get

  • Skills that the agent loads when your request matches one: Redocly CLI commands, redocly.yaml configuration, custom lint rules, Markdown linting with redocly recheck, and Redocly docs projects (setup, pages, and API reference docs). The Redocly skills index lists them.
  • The Redocly MCP server at https://redocly.com/mcp. It searches and reads the current Redocly documentation, and it reports a wrong or incomplete page to the Redocly documentation team.

Example prompts:

  • "Lint my OpenAPI description with Redocly CLI and explain each problem."
  • "Write a Redocly lint rule that requires an operationId on every operation."
  • "Set up a Redocly docs site for my OpenAPI description."

Data and privacy

The plugin itself runs no code on your machine: the skills are Markdown files, and the plugin adds only the Redocly MCP server. Some skills tell the agent to run Redocly CLI commands, which the agent runs like any other command. Redocly receives the tool calls that your agent sends, not your conversation, and keeps usage statistics such as the tool name, the duration, the name of your client and the plugin version. No tool changes your Redocly account or your projects. The Redocly Privacy Notice covers requests to the server.

Support

Open an issue for a problem with the plugin. We do not accept pull requests from outside Redocly. To report a security vulnerability, follow SECURITY.md. For anything else, contact Redocly.

License

MIT

來源:README.md,提交 5ec18b2

工具

3

execute

Query the docs with code

Run JavaScript in a sandbox against the documentation at https://redocly.com. The script calls the sandbox functions on the global `site` object. The only extra global is `site` - there is no `fetch`, `console`, `setTimeout`, `require`, or Node.js API; all I/O goes through `site`. Workflow - minimize round-trips; one `discover` call plus one `execute` call covers most requests: 1. Analyze the request and decide which sandbox functions it needs. 2. Call `discover` with those names to get their exact TypeScript signatures - inputs, result shapes, and a worked example. NEVER call `execute` with guessed function names, parameter names, enum values, or result field names: read fields off the declared return types, not from assumptions. 3. Batch everything into a SINGLE script: chain function calls, pass one call's output into the next, process results in plain JavaScript, and `return` only what the request needs. Functions for `execute` scripts (signatures come from `discover`): - listApis — List the available APIs. - getEndpoints — Get all endpoints for an API. - getEndpointInfo — Get the details of an endpoint. - getSecuritySchemes — Get the security schemes for an API. - getFullApiDescription — Get the complete OpenAPI description. - search — Search the documentation. - listPages — List the docs navigation, one level per call. - getPage — Read a docs page as Markdown, in line windows. - grepPages — Find the docs lines that contain a text.

輸入參數code必填description必填

discover

Get docs function signatures

Get the exact TypeScript signatures of the sandbox functions that `execute` scripts can call. Analyze the user request first, then pass `names` with only the functions the request needs (every name is listed in this input schema / description); omit `names` only when you cannot tell which functions apply. Always call this before your first `execute` and never guess signatures. Request every function the task may need in ONE call instead of calling this repeatedly.

輸入參數names

submit-feedback

Submit feedback

Report a documentation page that is wrong or incomplete. Use it when the user reports a problem with a page on this site, or agrees to report a problem that you found. Do not use it for product bugs or support questions.

輸入參數path必填detailssummary必填targetFeature

版本歷史

2
  1. v1.0.1最新Oct 26, 2026
  2. v1.0.0Oct 20, 2026

評分

已滿足適用檢查項的 100%

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

  • 近 30 天內可連通必需25 分
  • 已宣告認證方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分