English Français العربية

Redocly

السجل الرسمي البحث والويب

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

الشيفرة المصدرية الموقع التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

Remote (streamable-http)
Claude Code 
claude mcp add --transport http redocly 'https://redocly.com/mcp' --header 'X-Redocly-MCP-Source: <X-Redocly-MCP-Source>'
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "redocly": {
            "type": "http",
            "url": "https://redocly.com/mcp",
            "headers": {
                "X-Redocly-MCP-Source": "<X-Redocly-MCP-Source>"
            }
        }
    }
}

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. Redocly plugin
  2. Install
  3. What you get
  4. Data and privacy
  5. Support
  6. License

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:

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: 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:

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

الأسئلة الشائعة

ما هو Redocly؟

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

كيف أثبّت Redocly؟

يعمل كخادم بعيد. في Claude Code: claude mcp add --transport http redocly 'https://redocly.com/mcp' --header 'X-Redocly-MCP-Source: <X-Redocly-MCP-Source>'. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج Redocly إلى مفتاح API؟

نعم. يتطلب X-Redocly-MCP-Source، وتضبطها في إعداداته.

هل Redocly مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون Redocly؟

ينشره Redocly. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.