Skip to content

Document MCP discovery endpoint #5715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 2 commits into from
May 8, 2026
+37 −0
Merged

Document MCP discovery endpoint #5715

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26a9f04
Document /.well-known/mcp discovery endpoint
mintlify[bot] May 8, 2026
2c51e20
💅
ethanpalm May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions ai/model-context-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
The MCP search tool supports optional parameters that AI applications use to control and refine search results.

- **`pageSize`**: Number of results to return, between 1 and 50. Defaults to 10.
- **`scoreThreshold`**: Minimum relevance score between 0 and 1. Returns only results at or above this score. Use this to filter out low-relevance matches.

Check warning on line 51 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L51 

Use 'preceding' instead of 'above'.
- **`version`**: Filter results to a specific documentation version. For example, `'v0.7'`. Only returns content tagged with the specified version or content available across all versions.
- **`language`**: Filter results to a specific language code. For example, `'en'`, `'zh'`, or `'es'`. Only returns content in the specified language or content available across all languages.

Expand Down Expand Up @@ -81,6 +81,43 @@
Hosted MCP servers use the `/mcp` and `/authed/mcp` paths. Other navigation elements cannot use these paths.
</Note>

### Discovery endpoint

Mintlify hosts a discovery document at `/.well-known/mcp` for agents and tools to locate your MCP server without prior configuration.

`GET /.well-known/mcp` returns a JSON document describing your MCP server:

```json
{
"version": "1.0.0",
"transport": "http",
"url": "https://your-docs.com/mcp",
"servers": [
{
"name": "public",
"url": "https://your-docs.com/mcp",
"transport": "http",
"authentication": "none"
},
{
"name": "authenticated",
"url": "https://your-docs.com/authed/mcp",
"transport": "http",
"authentication": "oauth2"
}
]
}
```

| Field | Description |
| --- | --- |
| `version` | The MCP server version. |
| `transport` | The transport protocol. Always `http`. |
| `url` | The default public MCP server URL. |
| `servers` | Available MCP servers. Always includes a `public` entry. When authentication is enabled on your site, also includes an `authenticated` entry. |
| `servers[].name` | Identifier for the server entry. |
| `servers[].authentication` | Authentication method for the server entry. |

### Enable authenticated MCP

If your documentation requires authentication, your MCP server requires users to authenticate before connecting. When a user adds your MCP server URL to their AI tool, they must log in with their existing credentials. After authenticating, a redirect sends them back to their tool. The MCP server only returns content each user has permission to access based on their [user groups](/deploy/authentication-setup).
Expand Down
Loading