From e3b117bcb314921927ee631da18360895530b6ad Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 26 Mar 2026 00:00:31 +0000 Subject: [PATCH] Add x-mint.mcp extension documentation to OpenAPI setup Generated-By: mintlify-agent --- api-playground/openapi-setup.mdx | 59 ++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index 0261771d8..681783ba1 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -258,6 +258,65 @@ Set the URL of the autogenerated endpoint page using `x-mint: href`. When `x-min } ``` +### MCP + +Control which API endpoints are exposed as tools on your [MCP server](/ai/model-context-protocol) by adding `x-mint: mcp` to any operation. By default, all endpoints in your OpenAPI specification are available as MCP tools. Use this extension to disable specific endpoints, or to customize the tool name and description that AI applications see. + +```json {6-10} +{ + "paths": { + "/users": { + "get": { + "summary": "List users", + "x-mint": { + "mcp": { + "enabled": false + } + } + } + } + } +} +``` + +The `mcp` object supports the following properties: + + + Whether to expose this endpoint as an MCP tool. Set to `false` to hide the endpoint from your MCP server. + + + + Override the tool name that AI applications see. If not set, Mintlify generates a name from the operation ID or the HTTP method and path. + + + + Override the tool description that AI applications see. If not set, Mintlify uses the operation's `summary` or `description`. + + +You can customize the tool name and description to help AI applications understand when and how to use the endpoint: + +```json {6-10} +{ + "paths": { + "/users/search": { + "post": { + "summary": "Search users by filters", + "x-mint": { + "mcp": { + "name": "search_users", + "description": "Search for users by name, email, or role. Returns paginated results." + } + } + } + } + } +} +``` + + + The legacy `x-mcp` extension at the operation level is still supported but `x-mint: mcp` is preferred. If both are present, `x-mint: mcp` takes precedence. + + ## Auto-populate API pages Add an `openapi` field to any navigation element in your `docs.json` to automatically generate pages for OpenAPI endpoints. You can control where these pages appear in your navigation structure, as dedicated API sections or with other pages.