Skip to content
Open
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
15 changes: 13 additions & 2 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

The admin MCP server gives AI tools write access to your Mintlify content and settings. Use it to update content and access your dashboard. With the admin MCP, you can use your preferred AI tools to edit pages, restructure navigation, update `docs.json`, open pull requests, change settings, create workflows, and more.

Connect an MCP client such as Claude, Claude Code, ChatGPT, or Cursor to the admin MCP server. Use it to collaborate on your Mintlify content and settings with the same tools you use to write code. All changes happen on a branch and require a pull request to merge. If your organization has multiple deployments, a single admin MCP connection can access and switch between all of them.
Connect an MCP client such as Claude, Claude Code, ChatGPT, or Cursor to the admin MCP server. Use it to collaborate on your Mintlify content and settings with the same tools you use to write code. Content edits happen on a branch and ship through a pull request or commit when you call `save`. [Deployment management](#deployment-management) changes, such as workflow and settings updates, apply immediately to the live deployment. If your organization has multiple deployments, a single admin MCP connection can access and switch between all of them.

<Note>
The admin MCP server allows AI tools to access your Mintlify dashboard. Treat it as a tool with write access. Connect it only from trusted AI tools and review every pull request before merging.
The admin MCP server allows AI tools to access your Mintlify dashboard. Treat it as a tool with write access. Connect it only from trusted AI tools, review every pull request before merging, and be aware that deployment management changes apply immediately without a pull request.
</Note>

The admin MCP is a hosted Mintlify service at `https://mcp.mintlify.com`. Every client connects to the same endpoint and authenticates with your Mintlify account.
Expand Down Expand Up @@ -138,7 +138,7 @@

This toggle shares the same `agentReviewProcess` setting as the Slack and dashboard agent, so any change here also applies to those flows.

The toggle is disabled in three cases:

Check warning on line 141 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L141

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

- **Your deploy branch requires a pull request.** If branch protection rules or required approvals prevent direct pushes, MCP changes always open a pull request regardless of this setting.
- **Mintlify hosts your deployment.** For Mintlify-hosted sites, MCP changes always push directly, unless branch protection still requires a pull request.
Expand Down Expand Up @@ -167,6 +167,17 @@

- **`update_config`**: Modify `docs.json` (theme, navigation roots, integrations, SEO settings).

### Deployment management

Code mode handles deployment-level operations that have no dedicated tool, such as managing workflows, deployment settings, members, billing, integrations, and analytics. Code mode tools don't require a `checkout`.

- **`search_code_operations`**: Search the deployment management methods available to code mode. Each result includes the method's full input schema.
- **`execute_code`**: Run a TypeScript script against the deployment management methods. The connection's granted scopes gate every method, and any method you weren't granted returns an authorization error.

<Warning>
Code mode writes apply immediately to the live deployment. They don't create a branch or open a pull request. Confirm the intended change before prompting an AI tool to update workflows, settings, members, billing, or integrations.
</Warning>

### Session

- **`list_deployments`**: List the deployments your connection can access, returning each `{subdomain, name}`. Call this to discover which `subdomain` to pass to `checkout`.
Expand Down
2 changes: 2 additions & 0 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
boost: 3
---

This page is a complete reference for the commands and flags of the `mint` CLI. To install the CLI, see [Installation](/cli/install).

## Global flags

These flags are available on all commands.
Expand Down Expand Up @@ -91,9 +93,9 @@

| Client | Global configuration | Project configuration |
| --- | --- | --- |
| Claude Code | `~/.claude.json` | `.mcp.json` |

Check warning on line 96 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L96

Use 'Claude' instead of 'claude'.
| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
| VS Code | User `mcp.json` | `.vscode/mcp.json` |

Check warning on line 98 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L98

Use 'VSCode' instead of 'vscode'.
| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global only |
Expand Down Expand Up @@ -202,7 +204,7 @@

Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify deployment. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it.

Check warning on line 207 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L207

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

<Note>
If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values.
Expand Down Expand Up @@ -349,7 +351,7 @@

### `mint analytics stats`

Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. The output reports human and agent traffic separately.

Check warning on line 354 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L354

Did you really mean 'KPIs'?

```bash
mint analytics stats [flags]
Expand Down Expand Up @@ -498,7 +500,7 @@
| `--check-redirects` | Also check that redirect destinations in `docs.json` resolve to valid paths. |
| `--check-snippets` | Also check links inside `<Snippet>` components. |

Pass `--files` to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When `--files` is set with `--check-external`, only external URLs on the selected pages are fetched.

Check warning on line 503 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L503

In general, use active voice instead of passive voice ('are fetched').

```bash
# Check a specific page
Expand Down Expand Up @@ -637,13 +639,13 @@
mint format
```

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by `.gitignore` and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

Check warning on line 642 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L642

In general, use active voice instead of passive voice ('are left').

<Warning>
`mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff.
</Warning>

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting.

Check warning on line 648 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L648

In general, use active voice instead of passive voice ('were reformatted').

---

Expand Down Expand Up @@ -698,7 +700,7 @@

## Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does **not** collect personally identifiable information, project content, or file paths.

Check warning on line 703 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L703

Did you really mean 'informat'?

By default, the CLI collects telemetry data. You can opt out at any time using the `--telemetry` flag:

Expand Down
7 changes: 5 additions & 2 deletions deploy/route53-cloudfront.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Route traffic to these paths with a Cache Policy of **CachingDisabled**:
- `/docs/` - Required for subpath routing
- `/_mintlify/*` - Required for API playground requests

Route traffic to these paths with a Cache Policy of **CachingEnabled**:
Route traffic to these paths with a Cache Policy of **CachingOptimized**:

- `/mintlify-assets/*` - Required for CSS, JavaScript, and favicons
- `Default (*)` - Your website's landing page
Expand Down Expand Up @@ -211,10 +211,13 @@ All pages should route to your main landing page. When you append your chosen su

Next, connect the CloudFront distribution to your primary domain.

Before creating the Route 53 record, add your domain to the distribution. In your distribution's "General" tab, add your domain (for example, `yoursite.com`) as an **Alternate domain name (CNAME)** and attach an AWS Certificate Manager (ACM) certificate that covers it. Without an alternate domain name, CloudFront rejects requests that arrive through your domain.

<Note>
For this section, you can also refer to AWS's official guide on [Configuring
Amazon Route 53 to route traffic to a CloudFront
distribution](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config).
distribution](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config),
which covers these prerequisites.
</Note>

1. Navigate to [Route53](https://aws.amazon.com/route53) inside the AWS console.
Expand Down
10 changes: 10 additions & 0 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"]
---

## Home and Publishing

Check warning on line 8 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L8

'Home and Publishing' should use sentence-style capitalization.

The editor workspace is split into two tabs: **Home** and **Publishing**.

Check warning on line 10 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L10

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

**Home** is your workspace. It shows the content files in your repository, including your private pages, whether or not they appear on your published site.

Check warning on line 12 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L12

Use the Oxford comma in 'It shows the content files in your repository, including your private pages, whether or'.

**Publishing** is your published site. It shows the navigation your visitors see, along with your site settings.

Expand Down Expand Up @@ -49,6 +49,16 @@

To change a page's title, slug, description, or layout, open its settings from the navigation tree. See [Pages](/organize/pages) for more information on specific settings.

## Delete a page

To delete a page, click <Icon icon="ellipsis" /> **More options** in the top-right of the page, then click **Move to trash**. You can also delete a page from its options menu in the navigation tree.

Deleting a page removes both the file and its navigation entry. The deletion commits to your repository when you publish. If you delete a page by mistake, use the undo prompt that appears after deleting.

To remove a page from your published navigation without deleting its file, select **Remove from publishing** in the page's options menu in the navigation tree.

Viewers can't delete pages. For private pages, the menu shows **Delete page** instead, and the deletion is immediate because private pages aren't committed to your repository.

## Version history

Version history lets you review and restore earlier saved versions of a page. It isn't available for `docs.json`.
Expand All @@ -59,7 +69,7 @@

To view version history, click <Icon icon="ellipsis" /> **More options** in the top-right of the page, then click **Version history**.

If you restore a version, it overwrites any unsaved changes you made to the page. When you restore a public page, it is only restored on your current branch. When you restore a private page, it is restored on all branches.

Check warning on line 72 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L72

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

## Private pages

Expand Down
17 changes: 15 additions & 2 deletions es/ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ keywords: ["MCP", "write access", "AI", "editing", "Claude", "ChatGPT", "Cursor"

El servidor Admin MCP otorga a las herramientas de IA acceso de escritura a tu contenido y configuración de Mintlify. Úsalo para actualizar contenido y acceder a tu panel. Con el Admin MCP, puedes usar tus herramientas de IA preferidas para editar páginas, reestructurar la navegación, actualizar `docs.json`, abrir pull requests, cambiar configuraciones, crear workflows y más.

Conecta cualquier cliente MCP como Claude, Claude Code, ChatGPT o Cursor al servidor Admin MCP para colaborar en tu contenido y configuración de Mintlify con las mismas herramientas que usas para escribir código. Cuando usas el servidor Admin MCP, todos los cambios ocurren en una rama y requieren una pull request para fusionarse. Si tu organización tiene varias implementaciones, una sola conexión de Admin MCP puede acceder a todas ellas y alternar entre ellas.
Conecta cualquier cliente MCP como Claude, Claude Code, ChatGPT o Cursor al servidor Admin MCP para colaborar en tu contenido y configuración de Mintlify con las mismas herramientas que usas para escribir código. Las ediciones de contenido ocurren en una rama y se publican mediante una pull request o un commit cuando llamas a `save`. Los cambios de [gestión de implementaciones](#deployment-management), como las actualizaciones de workflows y de configuración, se aplican de inmediato a la implementación en vivo. Si tu organización tiene varias implementaciones, una sola conexión de Admin MCP puede acceder a todas ellas y alternar entre ellas.

<Note>
El servidor Admin MCP permite que las herramientas de IA accedan a tu panel de Mintlify. Trátalo como a un compañero de trabajo con acceso de escritura. Conéctalo solo desde herramientas de IA de confianza y revisa cada pull request antes de fusionarla.
El servidor Admin MCP permite que las herramientas de IA accedan a tu panel de Mintlify. Trátalo como a un compañero de trabajo con acceso de escritura. Conéctalo solo desde herramientas de IA de confianza, revisa cada pull request antes de fusionarla y ten en cuenta que los cambios de gestión de implementaciones se aplican de inmediato sin una pull request.
</Note>

El Admin MCP es un servicio alojado por Mintlify en `https://mcp.mintlify.com`. Todos los clientes se conectan al mismo endpoint y se autentican con tu cuenta de Mintlify.
Expand Down Expand Up @@ -187,6 +187,19 @@ También puedes anular el ajuste caso por caso pasando un `mode` explícito a `s

- **`update_config`**: Modifica `docs.json` (tema, raíces de navegación, integraciones, configuración de SEO).

<div id="deployment-management">
### Gestión de implementaciones
</div>

El modo de código gestiona las operaciones a nivel de implementación que no tienen una herramienta dedicada, como administrar workflows, la configuración de la implementación, los miembros, la facturación, las integraciones y las analíticas. Las herramientas del modo de código no requieren un `checkout`.

- **`search_code_operations`**: Busca los métodos de gestión de implementaciones disponibles para el modo de código. Cada resultado incluye el esquema de entrada completo del método.
- **`execute_code`**: Ejecuta un script de TypeScript contra los métodos de gestión de implementaciones. Los ámbitos otorgados a la conexión controlan cada método, y cualquier método que no te haya sido otorgado devuelve un error de autorización.

<Warning>
Las escrituras del modo de código se aplican de inmediato a la implementación en vivo. No crean una rama ni abren una pull request. Confirma el cambio previsto antes de pedirle a una herramienta de IA que actualice workflows, configuraciones, miembros, facturación o integraciones.
</Warning>

<div id="session">
### Sesión
</div>
Expand Down
2 changes: 2 additions & 0 deletions es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ keywords: ["CLI", "mint", "comandos", "flags", "referencia"]
boost: 3
---

Esta página es una referencia completa de los comandos y flags de la CLI `mint`. Para instalarla, consulta [Instalar la CLI](/es/cli/install).

<div id="global-flags">
## Flags globales
</div>
Expand Down
12 changes: 7 additions & 5 deletions es/deploy/route53-cloudfront.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Dirige el tráfico a estas rutas con una política de caché **CachingDisabled**
- `/docs/` - Obligatorio para el enrutamiento por subruta
- `/_mintlify/*` - Obligatorio para las solicitudes del playground de API

Dirige el tráfico a estas rutas con una política de caché **CachingEnabled**:
Dirige el tráfico a estas rutas con una política de caché **CachingOptimized**:

- `/mintlify-assets/*` - Obligatorio para CSS, JavaScript y favicons
- `Default (*)` - La página de inicio de tu sitio web
Expand Down Expand Up @@ -75,7 +75,7 @@ Los comportamientos de tu subruta deben permitir todos los métodos HTTP. CloudF
## Agregar origen predeterminado
</div>

1. Después de crear la distribución, ve a la pestaña &quot;Origins&quot;.
1. Después de crear la distribución, ve a la pestaña "Origins".

<Frame>
![Una distribución de CloudFront con la pestaña "Origins" resaltada.](/images/cloudfront/origins.png)
Expand All @@ -89,7 +89,7 @@ Los comportamientos de tu subruta deben permitir todos los métodos HTTP. CloudF
Si usas Vercel, usa el domain `.vercel.app` disponible para cada proyecto.
</Info>

3. Crea un nuevo Origin y agrega tu URL de staging como el &quot;Origin domain&quot;.
3. Crea un nuevo Origin y agrega tu URL de staging como el "Origin domain".

<Frame>
![Página de CloudFront "Create origin" con el campo de entrada "Origin domain" resaltado.](/images/cloudfront/default-origin.png)
Expand Down Expand Up @@ -235,14 +235,16 @@ Todas las páginas deberían enrutar a tu página de inicio principal. Cuando ag

A continuación, conecta la distribución de CloudFront a tu dominio principal.

Antes de crear el registro de Route 53, agrega tu dominio a la distribución. En la pestaña "General" de tu distribución, agrega tu dominio (por ejemplo, `yoursite.com`) como **Alternate domain name (CNAME)** y adjunta un certificado de AWS Certificate Manager (ACM) que lo cubra. Sin un nombre de dominio alternativo, CloudFront rechaza las solicitudes que llegan a través de tu dominio.

<Note>
Para esta sección, también puedes consultar la guía oficial de AWS sobre [Configurar
Amazon Route 53 para enrutar el tráfico a una
distribución de CloudFront](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config)
distribución de CloudFront](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config), que cubre estos requisitos previos.
</Note>

1. Ve a [Route53](https://aws.amazon.com/route53) en la consola de AWS.
2. Ve a la &quot;Hosted zone&quot; de tu dominio principal.
2. Ve a la "Hosted zone" de tu dominio principal.
3. Selecciona **Create record**.

<Frame>
Expand Down
14 changes: 14 additions & 0 deletions es/editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,20 @@ Arrastre elementos en la vista Navigation para reordenarlos o anidarlos. El edit

Para cambiar el título, el slug, la descripción o el layout de una página, abra su configuración desde el árbol de navegación. Consulte [Páginas](/es/organize/pages) para obtener más información sobre cada ajuste.

<div id="delete-a-page">

## Eliminar una página

</div>

Para eliminar una página, haga clic en <Icon icon="ellipsis" /> **More options** en la esquina superior derecha de la página y luego haga clic en **Move to trash**. También puede eliminar una página desde su menú de opciones en el árbol de navegación.

Eliminar una página elimina tanto el archivo como su entrada de navegación. La eliminación se hace commit en su repositorio cuando publica. Si elimina una página por error, use el aviso de deshacer que aparece después de eliminarla.

Para quitar una página de su navegación publicada sin eliminar su archivo, seleccione **Remove from publishing** en el menú de opciones de la página en el árbol de navegación.

Los viewers no pueden eliminar páginas. Para las páginas privadas, el menú muestra **Delete page** en su lugar, y la eliminación es inmediata porque las páginas privadas no se hacen commit en su repositorio.

<div id="version-history">

## Historial de versiones
Expand Down
6 changes: 3 additions & 3 deletions es/poc-onboarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Tu repositorio sigue siendo la fuente de la verdad. El dashboard te permite edit
| Responsable de la documentación | Dirige la POC y completa la mayoría de los pasos. | Unas pocas horas en total |
| Administrador de GitHub | Aprueba la aplicación de GitHub de Mintlify. | 15 minutos |
| Diseñador o responsable de marca | Proporciona logotipos, colores y fuentes. | 30 minutos |
| Administrador de identidad o TI | Configura el DNS para un dominio personalizado, si pruebas la autenticación. | 1 a 2 horas |
| Administrador de identidad o TI | Configura el DNS para un dominio personalizado y conecta tu proveedor de identidad, si pruebas la [autenticación](/es/deploy/authentication-setup). | 1 a 2 horas |

<div id="gather-your-content-and-brand-assets">
### Reúne tu contenido y tus recursos de marca
Expand Down Expand Up @@ -114,7 +114,7 @@ Comparte el objetivo, la línea base y los criterios con tu AE o SE.
</Step>
</Steps>

Usa la URL `.mintlify.site` durante la POC. La autenticación funciona en un [dominio personalizado](/es/customize/custom-domain) o en tu subdominio `.mintlify.site`, pero no funciona en un subpath personalizado como `yourcompany.com/docs`. Consulta [Configuración de autenticación](/es/deploy/authentication-setup).
Usa la URL `.mintlify.site` durante la POC. La [autenticación](/es/deploy/authentication-setup) funciona en tu subdominio `.mintlify.site` o en un [dominio personalizado](/es/customize/custom-domain), pero no funciona en un subpath personalizado como `yourcompany.com/docs`.

<div id="step-2-invite-your-team">
## Paso 2: Invita a tu equipo
Expand Down Expand Up @@ -341,7 +341,7 @@ La mayoría de las POC toman dos a tres semanas:

| Semana | Enfoque |
|---|---|
| Semana 1 | Conecta el repositorio, invita a tu equipo, define el éxito y comienza la migración del contenido. Inicia la configuración del dominio si necesitas autenticación. |
| Semana 1 | Conecta el repositorio, invita a tu equipo, define el éxito y comienza la migración del contenido. Inicia la [configuración de la autenticación](/es/deploy/authentication-setup) si planeas probarla. |
| Semana 2 | Revisa el contenido, publica un cambio, aplica tu marca, prueba el asistente y evalúa un flujo de trabajo de IA. |
| Semana 3 | Revisa los resultados con tu responsable de la decisión. |

Expand Down
Loading