Skip to content
Last updated

Redocly MCP server

Use the Redocly MCP server to ask your AI assistant about Redocly products and to explore the API descriptions published on redocly.com. The server is a hosted Model Context Protocol (MCP) server. It is public: you do not need a Redocly account, a sign-in, or an API key.

The server URL is:

https://redocly.com/mcp

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

Before you begin

You must have an MCP client that supports remote servers over the Streamable HTTP transport.

Connect to the Redocly MCP server

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

Alternatively, follow the steps in the tab for your client:

For an automated installation, 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 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.

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.

Some clients work better with one tool for each operation. For these clients, use https://redocly.com/mcp?mode=tools.

Verify the connection

Ask your assistant: "Using the Redocly MCP server, list the APIs it documents."

Verify the connection
Using the Redocly MCP server, list the APIs it documents.

The answer lists the APIs published on redocly.com, for example the Redocly Museum API, which is a demo API.

Example prompts

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

Learn about Redocly products
Using the Redocly MCP server, what is Reunite, and how is it different from Realm?
Explore an API
What endpoints does the Redocly Museum API have?
Check API authentication
Which authentication scheme does the Redocly Museum API use, and how do I send the credentials?
Get started with Redocly CLI
How do I install Redocly CLI and lint an OpenAPI file?
Configure a docs site
Show me an example sidebar configuration for a Realm project.

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

What the server provides

The server runs in code mode. It does not expose one MCP tool for each documentation function. It exposes three tools:

ToolWhat it does
Get docs function signatures (discover)Returns the TypeScript signatures of the documentation functions, so that the assistant 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 documentation functions are the following:

FunctionWhat it does
searchSearches the content published on redocly.com: product documentation, learning content, and the blog.
listApisLists the APIs published on redocly.com, with their versions and servers.
getEndpointsLists the endpoints of an API with the method, path, summary, and security requirements of each one.
getEndpointInfoReturns the details of one endpoint: parameters, request body, responses, and security schemes.
getSecuritySchemesReturns the security schemes and the default security requirements of an API.
getFullApiDescriptionReturns the complete OpenAPI description of an API.

The server also publishes Redocly's agent skills as MCP resources, for example for Redocly CLI commands and lint rules. A client that supports resources can load a skill when a task needs it. The skills index lists the current skills.

Agents that support discovery can read the server card.

Troubleshooting

The assistant 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, and restart your client.

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 assistant to report the page with the Redocly MCP server, or contact Redocly.

Data and privacy

  • The server returns only content that is public on redocly.com.
  • Redocly receives the tool calls that your assistant sends, not your conversation.
  • The documentation tools only read data. The feedback tool adds a report for the Redocly documentation team. No tool changes your Redocly account or your projects.
  • Redocly keeps usage statistics, such as the tool name, the duration, the response size, and the name and version of your client.
  • The Redocly Privacy Notice covers requests to the server. The AI governance and security FAQ answers security questions about Redocly MCP servers.

Disconnect from the Redocly MCP server

ClientHow to disconnect
ClaudeOpen Customize > Connectors, select Redocly, then select Remove. On a Team or Enterprise plan, an Owner removes it in Organization settings > Connectors.
Claude CodeRun claude mcp remove redocly.
CursorRemove the redocly server on the Customize page, or delete the redocly entry from mcp.json.
VS CodeIn the Extensions view, right-click redocly in the MCP Servers - Installed section and select Uninstall. Or delete the redocly entry from .mcp.json.
CodexRun codex mcp remove redocly.
ChatGPTRemove the Redocly plugin or app in the ChatGPT settings. See OpenAI's guide to manage apps.

Resources

  • MCP servers - Run an MCP server for your own documentation site and restrict who can use it
  • MCP configuration reference - Configure the MCP server for your project in redocly.yaml
  • Agent skills - Package task instructions that agents load on demand, and publish them as MCP resources
  • Make docs AI ready - Every way Realm serves documentation to AI assistants and agents