Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions ai/model-context-protocol.mdx
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,41 @@
Hosted MCP servers use the `/mcp` and `/authed/mcp` paths. Other navigation elements cannot use these paths.
</Note>

### MCP discovery endpoint

Mintlify hosts a public discovery document at the `/.well-known/mcp` path of your documentation URL. AI tools and agent-readiness scanners use this endpoint to detect your MCP server, learn which transport it uses, and identify whether authentication is required—without needing to know your MCP server URL in advance.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L86

In general, use active voice instead of passive voice ('is required').

The discovery endpoint is publicly accessible, returns CORS headers, and does not require authentication. It mirrors the `/.well-known/llms.txt` convention.

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

```json
{
"name": "Your docs site",
"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"
}
]
}
```

The `servers` array always includes the public `/mcp` endpoint. If you have [authenticated MCP](#enable-authenticated-mcp) enabled, it also includes the `/authed/mcp` endpoint with `authentication: "oauth2"`.

Responses are cached for 24 hours.

### 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
35 changes: 35 additions & 0 deletions es/ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,41 @@ Puedes ver y copiar la URL de tu servidor MCP en la [página del servidor MCP](h
Los servidores MCP alojados utilizan las rutas `/mcp` y `/authed/mcp`. Otros elementos de navegación no pueden utilizar estas rutas.
</Note>

### Endpoint de descubrimiento de MCP

Mintlify aloja un documento de descubrimiento público en la ruta `/.well-known/mcp` de la URL de tu documentación. Las herramientas de IA y los escáneres de preparación para agentes usan este endpoint para detectar tu servidor MCP, conocer qué transporte utiliza e identificar si requiere autenticación, sin necesidad de conocer previamente la URL de tu servidor MCP.

El endpoint de descubrimiento es de acceso público, devuelve cabeceras CORS y no requiere autenticación. Sigue la convención de `/.well-known/llms.txt`.

`GET /.well-known/mcp` devuelve un documento JSON que describe tu servidor MCP:

```json
{
"name": "Your docs site",
"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"
}
]
}
```

El array `servers` siempre incluye el endpoint público `/mcp`. Si tienes habilitado [MCP autenticado](#enable-authenticated-mcp), también incluye el endpoint `/authed/mcp` con `authentication: "oauth2"`.

Las respuestas se almacenan en caché durante 24 horas.

<div id="enable-authenticated-mcp">
### Habilitar MCP autenticado
</div>
Expand Down
35 changes: 35 additions & 0 deletions fr/ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,41 @@ Vous pouvez afficher et copier l&#39;URL de votre serveur MCP sur la [page du se
Les serveurs MCP hébergés utilisent les chemins `/mcp` et `/authed/mcp`. Les autres éléments de navigation ne peuvent pas utiliser ces chemins.
</Note>

### Endpoint de découverte MCP

Mintlify héberge un document de découverte public au chemin `/.well-known/mcp` de l'URL de votre documentation. Les outils d'IA et les scanners de compatibilité agent utilisent cet endpoint pour détecter votre serveur MCP, identifier le transport qu'il utilise et déterminer si l'authentification est requise, sans avoir besoin de connaître à l'avance l'URL de votre serveur MCP.

L'endpoint de découverte est accessible publiquement, renvoie des en-têtes CORS et ne nécessite pas d'authentification. Il suit la convention `/.well-known/llms.txt`.

`GET /.well-known/mcp` renvoie un document JSON qui décrit votre serveur MCP :

```json
{
"name": "Your docs site",
"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"
}
]
}
```

Le tableau `servers` inclut toujours l'endpoint public `/mcp`. Si vous avez activé [le MCP authentifié](#enable-authenticated-mcp), il inclut également l'endpoint `/authed/mcp` avec `authentication: "oauth2"`.

Les réponses sont mises en cache pendant 24 heures.

<div id="enable-authenticated-mcp">
### Activer le MCP avec authentification
</div>
Expand Down
35 changes: 35 additions & 0 deletions zh/ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,41 @@ Mintlify 会为你的文档生成一个 MCP 服务器,并将其托管在你的
托管的 MCP 服务器使用 `/mcp` 和 `/authed/mcp` 路径。其他导航元素不能使用这些路径。
</Note>

### MCP 发现端点

Mintlify 在你的文档 URL 的 `/.well-known/mcp` 路径上托管一个公开的发现文档。AI 工具和 agent 就绪扫描器可以通过该端点检测到你的 MCP 服务器,了解它使用的传输方式,并识别是否需要身份验证,无需提前知道你的 MCP 服务器 URL。

该发现端点对外公开可访问,返回 CORS 头部,并且无需身份验证。它遵循 `/.well-known/llms.txt` 的约定。

`GET /.well-known/mcp` 返回描述你的 MCP 服务器的 JSON 文档:

```json
{
"name": "Your docs site",
"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"
}
]
}
```

`servers` 数组始终包含公开的 `/mcp` 端点。如果你已启用[认证 MCP](#enable-authenticated-mcp),它还会包含 `/authed/mcp` 端点,其 `authentication` 为 `"oauth2"`。

响应会缓存 24 小时。

<div id="enable-authenticated-mcp">
### 启用 MCP 认证
</div>
Expand Down
Loading