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
14 changes: 7 additions & 7 deletions ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. Mintlify generates an MCP server from your documentation, preparing your content for the broader AI ecosystem where any MCP client like Claude, Cursor, Goose, ChatGPT, and others can connect to your documentation.

Your MCP server exposes tools for AI applications to search your documentation and retrieve full page content. Your users must connect your MCP server to their tools.
Your MCP server exposes tools for AI applications to search your documentation and read page content directly from your documentation source files. Your users must connect your MCP server to their tools.

### How MCP servers work

When an AI application connects to your documentation MCP server, it can search your documentation and retrieve full page content directly in response to a user's prompt instead of relying on information from its training data or making a generic web search. Your MCP server provides access to all indexed content on your documentation site.
When an AI application connects to your documentation MCP server, it can search your documentation and read page content directly in response to a user's prompt instead of relying on information from its training data or making a generic web search. Your MCP server provides access to all indexed content on your documentation site.

- AI applications can proactively search your documentation while generating a response even if not explicitly asked to search your documentation for an answer.
- AI applications determine when to use the available tools based on the context of the conversation and the relevance of your documentation.
Expand All @@ -29,26 +29,26 @@
Your MCP server provides two tools that AI applications can use:

- **Search**: Searches across your documentation to find relevant content, returning snippets with titles and links. Use this when you need to discover information or find pages matching a query.
- **Get page**: Retrieves the full content of a specific documentation page by its path. Use this when you already know the page path, such as from search results, and need the complete content rather than a snippet.
- **Query docs filesystem**: Runs a shell command against a virtualized, read-only filesystem that contains your documentation source files. Use this to read full page content, list the file tree, or search across multiple pages in a single call. Supported commands include `head`, `cat`, `tree`, `rg` (ripgrep), and other read-only utilities.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L32

Did you really mean 'virtualized'?

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L32

Did you really mean 'ripgrep'?

AI applications determine when to use each tool based on the context of the conversation. For example, an AI application might first search your documentation to find relevant pages, then use the get page tool to retrieve the full content of the most relevant result.
AI applications determine when to use each tool based on the context of the conversation. For example, an AI application might first search your documentation to find relevant pages, then use the filesystem tool to read the full content of those pages.

### Search parameters

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. Only returns results at or above this threshold. Use this to filter out low-relevance matches.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L41

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.

AI applications determine when to apply these parameters based on the context of the user's query. For example, if a user asks about a specific API version, the AI application may automatically apply the appropriate filter to provide more relevant results.

### Get page parameters
### Query docs filesystem parameters

The get page tool accepts one required parameter:
The query docs filesystem tool accepts one required parameter:

- **`page`**: The page path to retrieve, such as `'api-reference/create-customer'`. Use page paths returned from search results.
- **`command`**: A shell command to run against the virtualized documentation filesystem. For example, `tree / -L 2` to list the file structure, `head -80 /path/page.mdx` to read a page, or `rg -il "keyword" /` to search across all pages.

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

Did you really mean 'virtualized'?

### MCP compared to web search

Expand Down
16 changes: 8 additions & 8 deletions es/ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"

El Model Context Protocol (MCP) es un protocolo abierto que crea conexiones estandarizadas entre aplicaciones de IA y servicios externos, como la documentación. Mintlify genera un servidor MCP a partir de tu documentación, preparando tu contenido para el ecosistema de IA más amplio, donde cualquier cliente MCP (como Claude, Cursor, Goose y otros) puede conectarse a tu documentación.

Tu servidor MCP expone herramientas para que las aplicaciones de IA puedan buscar en tu documentación y obtener el contenido completo de las páginas. Tus usuarios deben conectar tu servidor MCP a sus herramientas.
Tu servidor MCP expone herramientas para que las aplicaciones de IA puedan buscar en tu documentación y leer el contenido de las páginas directamente desde tus archivos fuente. Tus usuarios deben conectar tu servidor MCP a sus herramientas.

<div id="how-mcp-servers-work">
### Cómo funcionan los servidores MCP
</div>

Cuando una aplicación de IA se conecta a tu servidor MCP de documentación, puede buscar en tu documentación y obtener el contenido completo de las páginas directamente en respuesta a la instrucción de un usuario, en lugar de basarse en información de sus datos de entrenamiento o realizar una búsqueda genérica en la web. Tu servidor MCP proporciona acceso a todo el contenido indexado de tu sitio de documentación.
Cuando una aplicación de IA se conecta a tu servidor MCP de documentación, puede buscar en tu documentación y leer el contenido de las páginas directamente en respuesta a la instrucción de un usuario, en lugar de basarse en información de sus datos de entrenamiento o realizar una búsqueda genérica en la web. Tu servidor MCP proporciona acceso a todo el contenido indexado de tu sitio de documentación.

* Las aplicaciones de IA pueden buscar proactivamente en tu documentación mientras generan una respuesta, incluso si no se les pide explícitamente que busquen en tu documentación para encontrar una respuesta.
* Las aplicaciones de IA determinan cuándo usar las herramientas disponibles según el contexto de la conversación y la relevancia de tu documentación.
Expand All @@ -35,9 +35,9 @@ Cuando una aplicación de IA se conecta a tu servidor MCP de documentación, pue
Tu servidor MCP proporciona dos herramientas que las aplicaciones de IA pueden usar:

- **Search**: Busca en toda tu documentación para encontrar contenido relevante, devolviendo fragmentos con títulos y enlaces. Úsala cuando necesites descubrir información o encontrar páginas que coincidan con una consulta.
- **Get page**: Obtiene el contenido completo de una página de documentación específica por su ruta. Úsala cuando ya conozcas la ruta de la página, como a partir de los resultados de búsqueda, y necesites el contenido completo en lugar de un fragmento.
- **Query docs filesystem**: Ejecuta un comando shell contra un sistema de archivos virtualizado de solo lectura que contiene tus archivos fuente de documentación. Úsala para leer el contenido completo de las páginas, listar el árbol de archivos o buscar en varias páginas en una sola llamada. Los comandos compatibles incluyen `head`, `cat`, `tree`, `rg` (ripgrep) y otras utilidades de solo lectura.

Las aplicaciones de IA determinan cuándo usar cada herramienta según el contexto de la conversación. Por ejemplo, una aplicación de IA podría primero buscar en tu documentación para encontrar páginas relevantes y luego usar la herramienta get page para obtener el contenido completo del resultado más relevante.
Las aplicaciones de IA determinan cuándo usar cada herramienta según el contexto de la conversación. Por ejemplo, una aplicación de IA podría primero buscar en tu documentación para encontrar páginas relevantes y luego usar la herramienta de sistema de archivos para leer el contenido completo de esas páginas.

<div id="search-parameters">
### Parámetros de búsqueda
Expand All @@ -52,13 +52,13 @@ La herramienta de búsqueda MCP admite parámetros opcionales que las aplicacion

Las aplicaciones de IA determinan cuándo aplicar estos parámetros en función del contexto de la búsqueda del usuario. Por ejemplo, si un usuario pregunta por una versión específica de la API, la aplicación de IA puede aplicar automáticamente el filtro adecuado para ofrecer resultados más relevantes.

<div id="get-page-parameters">
### Parámetros de get page
<div id="query-docs-filesystem-parameters">
### Parámetros de query docs filesystem
</div>

La herramienta get page acepta un parámetro obligatorio:
La herramienta query docs filesystem acepta un parámetro obligatorio:

- **`page`**: La ruta de la página a obtener, como `'api-reference/create-customer'`. Usa las rutas de página devueltas por los resultados de búsqueda.
- **`command`**: Un comando shell para ejecutar contra el sistema de archivos virtualizado de documentación. Por ejemplo, `tree / -L 2` para listar la estructura de archivos, `head -80 /path/page.mdx` para leer una página, o `rg -il "keyword" /` para buscar en todas las páginas.

<div id="mcp-compared-to-web-search">
### MCP en comparación con la búsqueda en la web
Expand Down
16 changes: 8 additions & 8 deletions fr/ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"

Le Model Context Protocol (MCP) est un protocole ouvert qui crée des connexions standardisées entre les applications d&#39;IA et des services externes, comme la documentation. Mintlify génère un serveur MCP à partir de votre documentation, en préparant votre contenu pour un écosystème d&#39;IA plus vaste dans lequel n&#39;importe quel client MCP comme Claude, Cursor, Goose, ChatGPT et d&#39;autres peut se connecter à votre documentation.

Votre serveur MCP expose des outils permettant aux applications d'IA de rechercher dans votre documentation et de récupérer le contenu complet des pages. Vos utilisateurs doivent connecter votre serveur MCP à leurs outils.
Votre serveur MCP expose des outils permettant aux applications d'IA de rechercher dans votre documentation et de lire le contenu des pages directement depuis vos fichiers source. Vos utilisateurs doivent connecter votre serveur MCP à leurs outils.

<div id="how-mcp-servers-work">
### Fonctionnement des serveurs MCP
</div>

Lorsqu'une application d'IA se connecte à votre serveur MCP de documentation, elle peut rechercher dans votre documentation et récupérer le contenu complet des pages directement en réponse à la requête d'un utilisateur, au lieu de s'appuyer sur des informations issues de ses données d'entraînement ou d'effectuer une recherche générique sur le web. Votre serveur MCP donne accès à tout le contenu indexé de votre site de documentation.
Lorsqu'une application d'IA se connecte à votre serveur MCP de documentation, elle peut rechercher dans votre documentation et lire le contenu des pages directement en réponse à la requête d'un utilisateur, au lieu de s'appuyer sur des informations issues de ses données d'entraînement ou d'effectuer une recherche générique sur le web. Votre serveur MCP donne accès à tout le contenu indexé de votre site de documentation.

* Les applications d'IA peuvent rechercher de manière proactive dans votre documentation pendant qu'elles génèrent une réponse, même s'il ne leur a pas été explicitement demandé d'y rechercher une réponse.
* Les applications d'IA déterminent quand utiliser les outils disponibles en fonction du contexte de la conversation et de la pertinence de votre documentation.
Expand All @@ -35,9 +35,9 @@ Lorsqu'une application d'IA se connecte à votre serveur MCP de documentation, e
Votre serveur MCP fournit deux outils que les applications d'IA peuvent utiliser :

- **Search** : Recherche dans votre documentation pour trouver du contenu pertinent, en renvoyant des extraits avec des titres et des liens. Utilisez cet outil lorsque vous devez découvrir des informations ou trouver des pages correspondant à une requête.
- **Get page** : Récupère le contenu complet d'une page de documentation spécifique par son chemin. Utilisez cet outil lorsque vous connaissez déjà le chemin de la page, par exemple à partir des résultats de recherche, et que vous avez besoin du contenu complet plutôt que d'un extrait.
- **Query docs filesystem** : Exécute une commande shell sur un système de fichiers virtualisé en lecture seule contenant vos fichiers source de documentation. Utilisez cet outil pour lire le contenu complet des pages, lister l'arborescence des fichiers ou rechercher dans plusieurs pages en un seul appel. Les commandes prises en charge incluent `head`, `cat`, `tree`, `rg` (ripgrep) et d'autres utilitaires en lecture seule.

Les applications d'IA déterminent quand utiliser chaque outil en fonction du contexte de la conversation. Par exemple, une application d'IA peut d'abord rechercher dans votre documentation pour trouver des pages pertinentes, puis utiliser l'outil get page pour récupérer le contenu complet du résultat le plus pertinent.
Les applications d'IA déterminent quand utiliser chaque outil en fonction du contexte de la conversation. Par exemple, une application d'IA peut d'abord rechercher dans votre documentation pour trouver des pages pertinentes, puis utiliser l'outil filesystem pour lire le contenu complet de ces pages.

<div id="search-parameters">
### Paramètres de recherche
Expand All @@ -52,13 +52,13 @@ L’outil de recherche MCP prend en charge des paramètres facultatifs que les a

Les applications d’IA déterminent quand appliquer ces paramètres en fonction du contexte de la requête de l’utilisateur. Par exemple, si un utilisateur pose une question sur une version spécifique d’une API, l’application d’IA peut appliquer automatiquement le filtre approprié pour fournir des résultats plus pertinents.

<div id="get-page-parameters">
### Paramètres de get page
<div id="query-docs-filesystem-parameters">
### Paramètres de query docs filesystem
</div>

Loutil get page accepte un paramètre obligatoire :
L'outil query docs filesystem accepte un paramètre obligatoire :

- **`page`** : Le chemin de la page à récupérer, par exemple `'api-reference/create-customer'`. Utilisez les chemins de page renvoyés par les résultats de recherche.
- **`command`** : Une commande shell à exécuter sur le système de fichiers virtualisé de documentation. Par exemple, `tree / -L 2` pour lister la structure des fichiers, `head -80 /path/page.mdx` pour lire une page, ou `rg -il "keyword" /` pour rechercher dans toutes les pages.

<div id="mcp-compared-to-web-search">
### MCP par rapport à la recherche sur le web
Expand Down
16 changes: 8 additions & 8 deletions zh/ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"

Model Context Protocol (MCP,模型上下文协议) 是一个开放协议,用于在 AI 应用与外部服务 (例如文档) 之间建立标准化连接。Mintlify 会基于你的文档生成一个 MCP 服务器,为更广泛的 AI 生态系统做好准备,让任何 MCP 客户端例如 Claude、Cursor、Goose、ChatGPT 等都可以连接到你的文档。

你的 MCP 服务器会向 AI 应用提供搜索文档和获取完整页面内容的工具。你的用户必须将你的 MCP 服务器连接到他们的工具中。
你的 MCP 服务器会向 AI 应用提供搜索文档和直接从文档源文件读取页面内容的工具。你的用户必须将你的 MCP 服务器连接到他们的工具中。

<div id="how-mcp-servers-work">
### MCP 服务器的工作方式
</div>

当某个 AI 应用接入你的文档 MCP 服务器后,它可以直接根据用户提示搜索你的文档并获取完整页面内容,而不是依赖其训练数据中的信息或执行通用的网页搜索。你的 MCP 服务器会提供对文档站点上所有已建立索引内容的访问权限。
当某个 AI 应用接入你的文档 MCP 服务器后,它可以直接根据用户提示搜索你的文档并读取页面内容,而不是依赖其训练数据中的信息或执行通用的网页搜索。你的 MCP 服务器会提供对文档站点上所有已建立索引内容的访问权限。

* AI 应用可以在生成回复时主动搜索你的文档,即使没有被明确要求搜索你的文档来获取答案。
* AI 应用会根据对话的上下文以及你的文档与当前话题的相关性来决定何时使用可用的工具。
Expand All @@ -35,9 +35,9 @@ Model Context Protocol (MCP,模型上下文协议) 是一个开放协议,用
你的 MCP 服务器提供两个 AI 应用可以使用的工具:

- **Search**:在你的文档中搜索相关内容,返回带有标题和链接的摘要片段。当你需要发现信息或查找与查询匹配的页面时使用此工具。
- **Get page**:通过页面路径获取特定文档页面的完整内容。当你已经知道页面路径(例如来自搜索结果),并且需要完整内容而非摘要片段时使用此工具
- **Query docs filesystem**:对包含文档源文件的虚拟化只读文件系统执行 shell 命令。可用于读取完整页面内容、列出文件树,或在单次调用中搜索多个页面。支持的命令包括 `head`、`cat`、`tree`、`rg`(ripgrep)及其他只读工具

AI 应用会根据对话的上下文来决定何时使用每个工具。例如,AI 应用可能会先搜索你的文档以查找相关页面,然后使用 get page 工具获取最相关结果的完整内容
AI 应用会根据对话的上下文来决定何时使用每个工具。例如,AI 应用可能会先搜索你的文档以查找相关页面,然后使用文件系统工具读取这些页面的完整内容

<div id="search-parameters">
### 搜索参数
Expand All @@ -52,13 +52,13 @@ MCP 搜索工具支持可选参数,AI 应用使用它们来控制和优化搜

AI 应用会根据用户 query 的上下文来决定何时应用这些参数。例如,如果用户询问特定 API 版本,AI 应用可能会自动应用相应的筛选条件,以提供更相关的结果。

<div id="get-page-parameters">
### Get page 参数
<div id="query-docs-filesystem-parameters">
### Query docs filesystem 参数
</div>

get page 工具接受一个必填参数:
query docs filesystem 工具接受一个必填参数:

- **`page`**:要获取的页面路径,例如 `'api-reference/create-customer'`。使用搜索结果中返回的页面路径
- **`command`**:对虚拟化文档文件系统执行的 shell 命令。例如,`tree / -L 2` 列出文件结构,`head -80 /path/page.mdx` 读取页面内容,或 `rg -il "keyword" /` 在所有页面中搜索

<div id="mcp-compared-to-web-search">
### MCP 与网页搜索的对比
Expand Down
Loading