关于 Redocly
Redocly 插件为编码 Agent 提供 Redocly 技能,并通过 Redocly MCP 服务访问实时文档。适用于使用 Claude Code、Codex 或 Cursor 编写和维护 API 文档及 lint 配置的开发者。
主要功能
- 01提供 Redocly Agent 技能
- 02搜索和阅读当前文档
- 03报告错误或不完整页面
- 04支持 Claude Code、Codex 和 Cursor
适用场景
- 01查询 Redocly CLI 命令和配置
- 02编写自定义 lint 规则
- 03设置 OpenAPI 文档站点
MCP 相关
插件添加 Redocly MCP 服务;也可单独在支持 MCP 的客户端中连接 `https://redocly.com/mcp`,通过 Streamable HTTP 搜索、阅读文档并报告页面问题。
配置
远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。
https://redocly.com/mcpclaude mcp add --transport http com-redocly https://redocly.com/mcp{"mcpServers":{"com-redocly":{"type":"http","url":"https://redocly.com/mcp"}}}在 Cursor 中打开{"servers":{"com-redocly":{"type":"http","url":"https://redocly.com/mcp"}}}在 VS Code 中打开{"mcpServers":{"com-redocly":{"type":"http","url":"https://redocly.com/mcp"}}}{"mcpServers":{"com-redocly":{"serverUrl":"https://redocly.com/mcp"}}}命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。
https://redocly.com/mcp需要授权工具
详细介绍
Redocly 插件
Redocly 插件为你的 AI 编码 Agent 提供 Redocly 技能,并通过 Redocly MCP 服务实时访问 Redocly 文档。 它适用于 Claude Code、Codex 和 Cursor。
安装
Claude Code:
claude plugin marketplace add Redocly/redocly-plugin
claude plugin install redocly@redocly
Codex:
codex plugin marketplace add Redocly/redocly-plugin
codex plugin add redocly@redocly
Cursor:将此仓库导入为团队市场(适用于 Teams 和 Enterprise 计划),或将 plugins/redocly 复制到 ~/.cursor/plugins/local。
仅安装技能,适用于任何可读取 Agent Skills 的客户端:
npx skills add Redocly/redocly-plugin
仅安装 MCP 服务,适用于任何 MCP 客户端:将 https://redocly.com/mcp 添加为基于 Streamable HTTP 的远程服务,或从 MCP Registry 安装 com.redocly/mcp。Redocly MCP 服务文档列出了各客户端的安装步骤。
你将获得
- 技能:当你的请求符合某项技能时,Agent 会加载该技能,涵盖 Redocly CLI 命令、
redocly.yaml配置、自定义 lint 规则、使用redocly recheck进行 Markdown lint,以及 Redocly 文档项目(设置、页面和 API 参考文档)。Redocly 技能索引列出了这些技能。 - Redocly MCP 服务:地址为
https://redocly.com/mcp。它会搜索和读取最新的 Redocly 文档,并将错误或不完整的页面报告给 Redocly 文档团队。
提示词示例:
- “使用 Redocly CLI 检查我的 OpenAPI 描述,并解释每个问题。”
- “编写一条 Redocly lint 规则,要求每个操作都包含 operationId。”
- “为我的 OpenAPI 描述搭建一个 Redocly 文档站点。”
数据与隐私
此插件本身不会在你的计算机上运行任何代码:技能是 Markdown 文件,插件只会添加 Redocly MCP 服务。部分技能会让 Agent 运行 Redocly CLI 命令,Agent 会像运行其他命令一样运行这些命令。 Redocly 会收到 Agent 发送的工具调用,而不会收到你的对话内容,并会保留工具名称、调用时长、客户端名称和插件版本等使用统计信息。 没有任何工具会更改你的 Redocly 账户或项目。 Redocly 隐私声明适用于向该服务发送的请求。
支持
如果插件出现问题,请提交 issue。我们不接受来自 Redocly 以外人员的拉取请求。 若要报告安全漏洞,请按照 SECURITY.md 中的说明操作。其他问题请联系 Redocly。
许可证
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。