Skip to content
Last updated

Use Redocly with your AI client

Install Redocly in your AI client to get live access to the documentation on redocly.com. With the Redocly plugin in Claude Code, Codex, or Cursor, you also get the Redocly agent skills. The skills tell the AI client how to do Redocly tasks. The Redocly MCP server searches and reads the current Redocly documentation. You do not need a Redocly account, a sign-in, or an API key.

This page describes Redocly's own server only. To run an MCP server for your own documentation site, see MCP server.

Install

To add only the Redocly MCP server in one step, use the Connect to Claude button. You can select a different client from the drop-down menu, or copy the command or the configuration.

To install the skills and the server where your client supports it, follow the steps in the tab for your client:

Open the Redocly connector in the Claude directory and connect it.

To add the connector with a pre-filled link, select Add the Redocly connector to Claude. The link opens the Add custom connector dialog on claude.ai with the name and the URL filled in. Review the values and select Add.

To add the connector manually:

  1. 1

    Open Customize > Connectors, select Add, then select Add custom connector.

  2. 2

    Enter Redocly as the name and https://redocly.com/mcp as the URL, then select Continue.

  3. 3

    Review the detected authentication settings and select Continue.

  4. 4

    Under Authentication, select No sign in.

  5. 5

    Select Add.

On a Team or Enterprise plan, an Owner selects Connect for your team on the Redocly page in the Claude directory. Or the Owner opens Organization settings > Connectors, selects Add, then Custom > Web, and follows the same steps. Members then open Customize > Connectors and select Connect next to Redocly.

You can use the connector in Claude on the web and in the desktop app.

In Claude, Redocly is a connector. You get the server.

Other clients

Add https://redocly.com/mcp to your client as a remote server over the Streamable HTTP transport, with redocly as the name. The server doesn't require headers or credentials. Each client uses its own configuration keys, so follow your client's instructions for remote servers.

The server is listed in the MCP Registry as com.redocly/mcp.

Verify the connection

Ask your AI client: "Using the Redocly MCP server, how do I split an OpenAPI description into several files with Redocly CLI?"

Verify the connection
Using the Redocly MCP server, how do I split an OpenAPI description into several files with Redocly CLI?

The chat shows a call to the Redocly MCP server, and the answer uses the redocly split command. If the chat shows no call to the server, the AI client answered from memory.

Example prompts

After you connect, ask questions in natural language. The AI client decides which documentation functions to call.

Learn about Redocly products
Using the Redocly MCP server, what products does Redocly offer, and what does each one do?
Get started with Redocly CLI
Using the Redocly MCP server, how do I install Redocly CLI and lint an OpenAPI file?
Configure a docs site
Using the Redocly MCP server, show me an example sidebar configuration for a Redocly project.

If the AI client answers from memory instead of the documentation, name the server in the prompt. For example: "Check the Redocly MCP server before you answer."

What you get

The Redocly plugin gives your AI client the skills and the Redocly MCP server. The other ways to install give you the server only.

Skills

The Redocly plugin installs these agent skills:

SkillWhat it does
redocly-cliLints, bundles, splits, and joins API descriptions, builds and previews API docs, and runs the other Redocly CLI commands.
redocly-lint-rulesWrites a lint rule for an OpenAPI, AsyncAPI, or Arazzo description in redocly.yaml or in a custom plugin.
recheck-configSets up the recheck block and the recheck/* presets in redocly.yaml.
recheck-lintRuns redocly recheck on the Markdown files that you change, and fixes the problems that it finds.
redoclySets up, writes, previews, and publishes documentation with Redocly.
redocly-authoringAdds and changes the pages, links, Markdoc tags, sidebar, and navbar of a Redocly project.
redocly-api-docsAdds or changes the API reference docs for an OpenAPI, AsyncAPI, GraphQL, or SOAP description.

Your AI client loads a skill when your request matches it. The Redocly MCP server publishes the same skills as MCP resources, so a client that supports resources can load them without the plugin. The skills index lists the current skills.

Redocly MCP server

The server gives the AI client a set of documentation functions, such as search and endpoint lookup. The AI client calls these functions from a short script instead of through one MCP tool for each function. The server exposes three tools:

ToolWhat it does
Get docs function signatures (discover)Returns the TypeScript signatures of the documentation functions, so that the AI client knows how to call them.
Query the docs with code (execute)Runs a short JavaScript script that calls the documentation functions in a sandbox, and returns only the result. Scripts in the sandbox cannot make network requests.
Submit feedback (submit-feedback)Sends a report about a page on redocly.com that is wrong or incomplete to the Redocly documentation team. This is the only tool that writes data.

The following documentation functions read the pages on redocly.com:

FunctionWhat it does
searchSearches the content published on redocly.com: product documentation, learning content, and the blog.
listPagesLists the navigation of the pages on redocly.com, one level per call.
getPageReturns a page as Markdown, 200 lines per call by default, with the outline of its headings.
grepPagesFinds the lines in the pages that contain the text that you give.

The server also has documentation functions that list and read the API descriptions that redocly.com publishes, for example the Redocly platform API.

To get one MCP tool for each documentation function, use tools mode at https://redocly.com/mcp?mode=tools. The ChatGPT steps on this page use this URL.

AI clients that support discovery can read the server card.

Data and privacy

  • The server returns only content that is public on redocly.com.
  • Redocly receives the tool calls that your AI client sends, not your conversation.
  • The documentation tools only read data. The feedback tool adds a report for the Redocly documentation team. The report holds the page, the text of the report, and the name of your AI client. No tool changes your Redocly account or your projects.
  • Redocly keeps usage statistics, such as the tool name, the duration, and the response size. The statistics also hold the name and version of your client, and the IP address of the request. Redocly also keeps a security audit log of tool calls.
  • The Redocly plugin runs no code on your machine. The skills are Markdown files, and the plugin adds only the Redocly MCP server. Some skills tell the AI client to run Redocly CLI commands, which it runs like any other command.
  • The Redocly Privacy Notice covers requests to the server. The AI governance and security FAQ answers security questions about the MCP server.

Troubleshooting

The AI client does not use the server

Name the server in your prompt, for example: "Using the Redocly MCP server, ..."

The client asks you to sign in

The server does not use authentication. Select the option for no authentication in your client, or remove the server and add it again.

The tools are missing in the client

Make sure that the server URL is https://redocly.com/mcp, or https://redocly.com/mcp?mode=tools in ChatGPT, and restart your client.

The skills are missing

The skills come with the Redocly plugin in Claude Code, Codex, and Cursor. The other ways to install give you the server only. In another AI client that reads agent skills, run npx skills add Redocly/redocly-plugin.

The server returns HTTP 429

The server limits the number of requests from one IP address. Wait for the number of seconds in the Retry-After response header, then send the request again.

An answer is wrong or out of date

Ask your AI client to report the page with the Redocly MCP server, or contact Redocly.

Remove Redocly from your AI client

ClientHow to remove Redocly
ClaudeOpen Customize > Connectors, select Redocly, then select Remove. On a Team or Enterprise plan, an Owner removes it in Organization settings > Connectors.
Claude CodeTo remove the plugin, run claude plugin uninstall redocly@redocly. To also remove the Redocly marketplace, run claude plugin marketplace remove redocly. To remove the server only, run claude mcp remove redocly.
ChatGPTRemove Redocly from your ChatGPT plugins. See OpenAI's guide to manage apps.
CodexTo remove the plugin, run codex plugin remove redocly@redocly. To also remove the Redocly marketplace, run codex plugin marketplace remove redocly. To remove the server only, run codex mcp remove redocly.
CursorTo remove the plugin, delete the ~/.cursor/plugins/local/redocly folder and run Developer: Reload Window. If your team installed it from a team marketplace, ask a team admin to remove it there. To remove the server only, remove redocly on the Customize page. Or delete the redocly entry from mcp.json.
VS CodeIn the Extensions view, uninstall redocly from the MCP Servers - Installed section. Or delete the redocly entry from ~/.copilot/mcp-config.json.

Resources

  • MCP server - Serve your own documentation and API descriptions to AI clients over the Model Context Protocol
  • Agent skills - Package task instructions that agents load on demand, and publish them as MCP resources
  • Make docs AI ready - Every way Redocly serves documentation to AI clients
  • Redocly plugin repository - Read the plugin files and report a problem with the plugin