Skip to content

Update MCP docs: replace get_page with query_docs_filesystem #5292

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update MCP docs: replace get_page with query_docs_filesystem #5292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions ai/model-context-protocol.mdx
View file
Open in desktop
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 browse a read-only filesystem of your documentation pages. 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 browse your documentation files 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 @@ -28,27 +28,27 @@

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.
- **Search**: Searches across your documentation to find relevant content, returning snippets with titles and links. Use this for broad or conceptual queries.
- **Query docs filesystem**: Runs read-only shell commands against a virtual filesystem that contains your documentation pages as `.mdx` files and OpenAPI specs. AI agents use this tool to read full pages (`head -80 /quickstart.mdx`), explore the docs structure (`tree / -L 2`), search for exact keywords (`rg -il "rate limit" /`), and read multiple pages in one call. Each call is stateless and no data is written.

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 

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

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 query docs filesystem tool to read the full content of the most relevant results.

### 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 virtual documentation filesystem. For example, `head -80 /api-reference/create-customer.mdx` to read a page, `tree / -L 2` to list the directory structure, or `rg -il "keyword" /` to search file contents.

### MCP compared to web search

Expand Down Expand Up @@ -196,9 +196,9 @@
| :---- | :---- | :---------- |
| Per user (IP address) | 5,000 requests per hour | Limits how frequently a single user can query your MCP server configuration. |
| Search per documentation site (domain) | 10,000 requests per hour | Limits total search tool calls across all users of your MCP server. |
| Get page per documentation site (domain) | 10,000 requests per hour | Limits total get page tool calls across all users of your MCP server. |
| Query docs filesystem per documentation site (domain) | 10,000 requests per hour | Limits total query docs filesystem tool calls across all users of your MCP server. |
| Authenticated search per documentation site (domain) | 5,000 requests per hour | Limits total authenticated search tool calls across all users of your MCP server. |
| Authenticated get page per documentation site (domain) | 5,000 requests per hour | Limits total authenticated get page tool calls across all users of your MCP server. |
| Authenticated query docs filesystem per documentation site (domain) | 5,000 requests per hour | Limits total authenticated query docs filesystem tool calls across all users of your MCP server. |

## Content filtering and indexing

Expand Down
22 changes: 11 additions & 11 deletions es/ai/model-context-protocol.mdx
View file
Open in desktop
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 explorar un sistema de archivos de solo lectura de tus páginas de documentación. 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 explorar tus archivos de documentación 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 @@ -34,10 +34,10 @@ 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.
- **Search**: Busca en toda tu documentación para encontrar contenido relevante, devolviendo fragmentos con títulos y enlaces. Úsala para consultas amplias o conceptuales.
- **Query docs filesystem**: Ejecuta comandos shell de solo lectura contra un sistema de archivos virtual que contiene tus páginas de documentación como archivos `.mdx` y especificaciones OpenAPI. Los agentes de IA usan esta herramienta para leer páginas completas (`head -80 /quickstart.mdx`), explorar la estructura de la documentación (`tree / -L 2`), buscar palabras clave exactas (`rg -il "rate limit" /`) y leer múltiples páginas en una sola llamada. Cada llamada es sin estado y no se escribe ningún dato.

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 query docs filesystem para leer el contenido completo de los resultados más relevantes.

<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 a ejecutar contra el sistema de archivos virtual de documentación. Por ejemplo, `head -80 /api-reference/create-customer.mdx` para leer una página, `tree / -L 2` para listar la estructura de directorios, o `rg -il "keyword" /` para buscar en el contenido de los archivos.

<div id="mcp-compared-to-web-search">
### MCP en comparación con la búsqueda en la web
Expand Down Expand Up @@ -220,9 +220,9 @@ Para proteger la disponibilidad, Mintlify aplica límites de uso a los servidore
| :---------------------------------- | :------------------------- | :-------------------------------------------------------------------------------- |
| Por usuario (dirección IP) | 5.000 solicitudes por hora | Limita la frecuencia con la que un solo usuario puede consultar la configuración de tu servidor MCP. |
| Search por sitio de documentación (domain) | 10.000 solicitudes por hora | Limita el total de llamadas a la herramienta de búsqueda entre todos los usuarios de tu servidor MCP. |
| Get page por sitio de documentación (domain) | 10.000 solicitudes por hora | Limita el total de llamadas a la herramienta get page entre todos los usuarios de tu servidor MCP. |
| Query docs filesystem por sitio de documentación (domain) | 10.000 solicitudes por hora | Limita el total de llamadas a la herramienta query docs filesystem entre todos los usuarios de tu servidor MCP. |
| Search autenticado por sitio de documentación (domain) | 5.000 solicitudes por hora | Limita el total de llamadas autenticadas a la herramienta de búsqueda entre todos los usuarios de tu servidor MCP. |
| Get page autenticado por sitio de documentación (domain) | 5.000 solicitudes por hora | Limita el total de llamadas autenticadas a la herramienta get page entre todos los usuarios de tu servidor MCP. |
| Query docs filesystem autenticado por sitio de documentación (domain) | 5.000 solicitudes por hora | Limita el total de llamadas autenticadas a la herramienta query docs filesystem entre todos los usuarios de tu servidor MCP. |

<div id="content-filtering-and-indexing">
## Filtrado de contenido e indexación
Expand Down
Loading
Loading