Skip to content
Last updated

mcp

Redocly automatically generates Model Context Protocol (MCP) servers from your documentation and OpenAPI descriptions. MCP servers make your content accessible to AI tools in the MCP ecosystem (such as ChatGPT, Claude, Cursor, Goose).

Options

OptionTypeDescription
hidebooleanHide the MCP server globally. When set to true, all MCP functionality is disabled. Default: false.
docsDocs objectDocs MCP configuration options.

Docs object

OptionTypeDescription
hidebooleanHide the Docs MCP server. Default: false.
namestringSet the name displayed to MCP clients during the initial connection. Default: "Docs MCP server".
ignore[string]List of patterns or identifiers to ignore in the MCP server. Default: [].

Examples

# Global settings
mcp:
  hide: false
  # Docs MCP settings
  docs:
    hide: false
    name: My Custom Docs MCP Server

Ignore specific files and filename patterns in the MCP server:

# Global settings
mcp:
  hide: false
  docs:
    hide: false
    # Ignored patterns
    ignore:
      - openapi-files/**
      - test-endpoints

Default configuration

mcp:
  hide: false
  docs:
    hide: false
    name: "Docs MCP server"

Resources

  • MCP servers overview - Configure MCP servers and integrate with third-party services
  • Configuration options - Explore other project configuration options for comprehensive documentation and platform customization
 
Next page