Skip to main content

​
Availability

​
Overview

MCP is a documentation type alongside OpenAPI and GraphQL SDL. Once an operator has added MCP documentation to a Product, that content is reachable to developers from the Product’s catalogue card and from its detail page, the same way OpenAPI and GraphQL documentation already are.

​
Prerequisites

  • Developer Portal v1.19.0 or later
  • A Product with an MCP proxy and authored MCP documentation. See API Reference Documentation to add MCP content to a Product.
  • The Product published to a Catalog the developer has access to

​
The Service Explorer Tab

On a Product’s detail page, the Service explorer tab renders documentation for each of the Product’s Services. What it renders depends on the Service’s type:
  • An OpenAPI-documented API renders its specification in Redoc.
  • A GraphQL-documented API renders the GraphQL Playground.
  • An MCP proxy renders the operator-authored markdown content and the MCP server URL.
If a Product bundles more than one MCP proxy, a Select an API dropdown appears above the rendered content so the developer can switch between them. The first MCP proxy’s documentation loads with the page; the rest load on selection from their own docs page.

​
The MCP Documentation Page

Each MCP proxy also has its own documentation page, reachable from the catalogue card’s Docs dropdown or from the Service explorer tab. The page shows:
  • The MCP server URL, with a control to copy it
  • The operator-authored documentation, rendered from markdown
If no documentation has been authored for the MCP proxy, the page states that no documentation has been provided, rather than showing an empty page.
Documentation-only MCP Products (no access policy) are fully supported: their documentation page is reachable the same way as a regular Product’s.

​
Content Sanitization

Operator-authored MCP markdown is sanitized before it renders on the Live Portal: scripts, event handlers, and javascript: URLs are stripped. Standard Markdown and GitHub-Flavored Markdown formatting, including tables and task lists, render as authored.

​
What this page does not cover

There is no interactive tool testing on this page. Executing an MCP proxy’s tools from the Portal is covered by the embedded MCP Inspector.

​
Troubleshooting

No markdown has been authored for that MCP proxy yet. Add documentation from the Product’s API Reference Documentation section in the Admin Portal.
Use the Select an API dropdown above the rendered content on the Service explorer tab to switch between the MCP proxies in the Product.