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 分