diff --git a/cli/commands.mdx b/cli/commands.mdx
index d4485a4046..1834a5c3e4 100644
--- a/cli/commands.mdx
+++ b/cli/commands.mdx
@@ -1,7 +1,7 @@
---
title: "Mintlify CLI command reference"
sidebarTitle: "Commands"
-description: "Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint broken-links, and more."
+description: "Complete reference for Mintlify CLI commands and flags, including mint index, mint dev, mint validate, mint broken-links, and more."
keywords: ["CLI", "mint", "commands", "flags", "reference"]
boost: 3
---
@@ -35,6 +35,72 @@ mint dev [flags]
---
+## `mint index`
+
+Install the hosted Mintlify Index MCP server for your coding agents to search across all content on Mintlify sites. The server provides a `context` tool for researching libraries, frameworks, SDKs, APIs, and CLI tools.
+
+The Index MCP server is separate from the [Mintlify Docs MCP server](/ai/model-context-protocol), which searches your documentation site.
+
+```bash
+mint index [options]
+```
+
+### Options
+
+| Option | Description |
+| --- | --- |
+| `--claude` | Set up Claude Code. |
+| `--cursor` | Set up Cursor. |
+| `--vscode` | Set up VS Code. |
+| `--codex` | Set up Codex. |
+| `--opencode` | Set up OpenCode. |
+| `--windsurf` | Set up Windsurf. |
+| `--zed` | Set up Zed. |
+| `--project` | Write project-level configuration instead of global configuration when the client supports it. |
+| `--yes`, `-y` | Skip the picker and set up all detected clients. |
+
+### Select clients
+
+Run `mint index` without client options to detect installed clients and open an interactive picker. Select the clients to configure, then confirm the prompt.
+
+Pass one or more client options to configure specific clients without opening the picker:
+
+```bash
+mint index --claude --cursor
+```
+
+Use `--yes` to configure every detected client without prompts. If the CLI can't detect any clients, pass an explicit client option such as `--claude` or `--cursor`.
+
+Use `--project` with client options to write project configuration in the current directory:
+
+```bash
+mint index --project --cursor --vscode
+```
+
+### Configuration and rules
+
+The command adds the `mintlify-index` server to each selected client and points it to `https://index.mintlify.com/mcp`. By default, it updates global configuration. With `--project`, it uses project configuration where the client supports it.
+
+The command also adds a usage rule for each selected client except Zed. The rule tells the client to use the Index MCP `context` tool for documentation research, including syntax, configuration, migrations, and setup. It tells the client to prefer the tool over web search because training data can be out of date. The rule excludes general programming concepts and business-logic debugging.
+
+Windsurf has a global MCP configuration only. With `--project`, the command still writes the MCP entry to the global Windsurf configuration and writes the usage rule in the current project.
+
+Rerunning the command updates an existing `mintlify-index` entry and its generated rule. The command preserves unrelated configuration. If an existing JSON or JSONC configuration is invalid, the command reports an error without changing that file.
+
+Supported clients and their standard configuration files include:
+
+| Client | Global configuration | Project configuration |
+| --- | --- | --- |
+| Claude Code | `~/.claude.json` | `.mcp.json` |
+| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
+| VS Code | User `mcp.json` | `.vscode/mcp.json` |
+| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
+| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global only |
+| Zed | User `settings.json` | `.zed/settings.json` |
+
+---
+
## `mint signup`
Create a new Mintlify account from the terminal.
diff --git a/cli/index.mdx b/cli/index.mdx
index dac40af0d6..b45c030a3e 100644
--- a/cli/index.mdx
+++ b/cli/index.mdx
@@ -46,7 +46,7 @@ Run `mint format` to rewrite the MDX files in your project to Mintlify's canonic
Run `mint config` to set persistent defaults like your documentation subdomain.
- Working on your docs locally with an AI coding tool? Install the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) so your editor has the context it needs to write Mintlify-aware content.
+ Working on your docs locally with an AI coding tool? Install the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) so your editor has the context it needs to write Mintlify-aware content. Run [`mint index`](/cli/commands#mint-index) to give supported agents a context tool for researching external libraries, frameworks, SDKs, APIs, and CLI tools.
diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx
index f5a26b8e7a..0d705cec6a 100644
--- a/es/cli/commands.mdx
+++ b/es/cli/commands.mdx
@@ -1,7 +1,7 @@
---
title: "Referencia de comandos de la CLI de Mintlify"
sidebarTitle: "Comandos"
-description: "Referencia completa de todos los comandos y flags de la CLI de Mintlify, incluyendo mint dev, mint build, mint validate, mint broken-links y más."
+description: "Referencia completa de los comandos y flags de la CLI de Mintlify, incluidos mint index, mint dev, mint validate y mint broken-links."
keywords: ["CLI", "mint", "comandos", "flags", "referencia"]
boost: 3
---
@@ -39,6 +39,82 @@ mint dev [flags]
---
+
+ ## `mint index`
+
+
+Instala el servidor MCP Index alojado de Mintlify en tus agentes de codificación. El servidor proporciona una herramienta `context` para investigar bibliotecas, frameworks, SDK, API y herramientas CLI.
+
+El servidor MCP Index es independiente del [servidor MCP de Mintlify Docs](/es/ai/model-context-protocol), que busca en tu sitio de documentación.
+
+```bash
+mint index [options]
+```
+
+El comando también está disponible como `mintlify index`.
+
+
+ ### Opciones
+
+
+| Opción | Descripción |
+| --- | --- |
+| `--claude` | Configura Claude Code. |
+| `--cursor` | Configura Cursor. |
+| `--vscode` | Configura VS Code. |
+| `--codex` | Configura Codex. |
+| `--opencode` | Configura OpenCode. |
+| `--windsurf` | Configura Windsurf. |
+| `--zed` | Configura Zed. |
+| `--project` | Escribe la configuración del proyecto en lugar de la global cuando el cliente lo admite. |
+| `--yes`, `-y` | Omite el selector y configura todos los clientes detectados. |
+
+
+ ### Selecciona clientes
+
+
+Ejecuta `mint index` sin opciones de cliente para detectar los clientes instalados y abrir un selector interactivo. Los clientes detectados aparecen seleccionados de forma predeterminada. Selecciona los clientes que quieres configurar y confirma el aviso.
+
+Pasa una o más opciones de cliente para configurar clientes específicos sin abrir el selector:
+
+```bash
+mint index --claude --cursor
+```
+
+Usa `--yes` para configurar todos los clientes detectados sin avisos. Si no se detecta ningún cliente, pasa una opción explícita como `--claude` o `--cursor`.
+
+Usa `--project` con opciones de cliente para escribir la configuración del proyecto en el directorio actual:
+
+```bash
+mint index --project --cursor --vscode
+```
+
+
+ ### Configuración y reglas
+
+
+El comando añade el servidor `mintlify-index` a cada cliente seleccionado y lo apunta a `https://index.mintlify.com/mcp`. De forma predeterminada, actualiza la configuración global. Con `--project`, usa la configuración del proyecto cuando el cliente la admite.
+
+El comando también añade una regla de uso para cada cliente seleccionado excepto Zed. La regla indica al cliente que use la herramienta `context` del MCP Index para investigar documentación, incluyendo sintaxis, configuración, migraciones y configuración inicial. Indica al cliente que prefiera la herramienta a la búsqueda web porque los datos de entrenamiento pueden estar desactualizados. La regla excluye conceptos generales de programación y la depuración de lógica de negocio.
+
+Windsurf solo tiene configuración MCP global. Con `--project`, el comando sigue escribiendo la entrada MCP en la configuración global de Windsurf y escribe la regla de uso en el proyecto actual.
+
+Si vuelves a ejecutar el comando, actualiza la entrada `mintlify-index` existente y su regla generada. Conserva el resto de la configuración. Si una configuración JSON o JSONC existente no es válida, el comando muestra un error sin modificar ese archivo.
+
+Los clientes compatibles y sus archivos de configuración estándar incluyen:
+
+| Cliente | Configuración global | Configuración del proyecto |
+| --- | --- | --- |
+| Claude Code | `~/.claude.json` | `.mcp.json` |
+| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
+| VS Code | `mcp.json` de usuario | `.vscode/mcp.json` |
+| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
+| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Solo global |
+| Zed | `settings.json` de usuario | `.zed/settings.json` |
+
+---
+
## `mint signup`
diff --git a/es/cli/index.mdx b/es/cli/index.mdx
index 6810401930..3b9b4d9d20 100644
--- a/es/cli/index.mdx
+++ b/es/cli/index.mdx
@@ -64,7 +64,7 @@ Ejecuta `mint format` para reescribir los archivos MDX de tu proyecto siguiendo
Ejecuta `mint config` para establecer valores predeterminados persistentes como tu subdominio de documentación.
- ¿Trabajas en tus docs localmente con una herramienta de codificación con IA? Instala el [skill](/es/ai/skillmd) de Mintlify y el [servidor MCP](/es/ai/model-context-protocol) para que tu editor tenga el contexto que necesita para escribir contenido compatible con Mintlify.
+ ¿Trabajas en tus docs localmente con una herramienta de codificación con IA? Instala el [skill](/es/ai/skillmd) de Mintlify y el [servidor MCP](/es/ai/model-context-protocol) para que tu editor tenga el contexto que necesita para escribir contenido compatible con Mintlify. Ejecuta [`mint index`](/es/cli/commands#mint-index) para dar a los agentes compatibles una herramienta de contexto para investigar bibliotecas, frameworks, SDK, API y herramientas CLI externas.
diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx
index 292775f995..177616a8ca 100644
--- a/fr/cli/commands.mdx
+++ b/fr/cli/commands.mdx
@@ -1,7 +1,7 @@
---
title: "Référence des commandes de la CLI Mintlify"
sidebarTitle: "Commandes"
-description: "Référence complète de toutes les commandes et options de la CLI Mintlify, y compris mint dev, mint build, mint validate, mint broken-links et plus encore."
+description: "Référence complète des commandes et options de la CLI Mintlify, notamment mint index, mint dev, mint validate et mint broken-links."
keywords: ["CLI", "mint", "commandes", "flags", "référence"]
boost: 3
---
@@ -39,6 +39,82 @@ mint dev [flags]
---
+
+ ## `mint index`
+
+
+Installez le serveur MCP Index hébergé de Mintlify pour vos agents de codage. Le serveur fournit un outil `context` pour rechercher des bibliothèques, frameworks, SDK, API et outils CLI.
+
+Le serveur MCP Index est distinct du [serveur MCP Mintlify Docs](/fr/ai/model-context-protocol), qui effectue des recherches dans votre site de documentation.
+
+```bash
+mint index [options]
+```
+
+La commande est également disponible avec `mintlify index`.
+
+
+ ### Options
+
+
+| Option | Description |
+| --- | --- |
+| `--claude` | Configure Claude Code. |
+| `--cursor` | Configure Cursor. |
+| `--vscode` | Configure VS Code. |
+| `--codex` | Configure Codex. |
+| `--opencode` | Configure OpenCode. |
+| `--windsurf` | Configure Windsurf. |
+| `--zed` | Configure Zed. |
+| `--project` | Écrit la configuration du projet au lieu de la configuration globale lorsque le client le prend en charge. |
+| `--yes`, `-y` | Ignore le sélecteur et configure tous les clients détectés. |
+
+
+ ### Sélectionner les clients
+
+
+Exécutez `mint index` sans option de client pour détecter les clients installés et ouvrir un sélecteur interactif. Les clients détectés sont sélectionnés par défaut. Sélectionnez les clients à configurer, puis confirmez l'invite.
+
+Passez une ou plusieurs options de client pour configurer des clients précis sans ouvrir le sélecteur :
+
+```bash
+mint index --claude --cursor
+```
+
+Utilisez `--yes` pour configurer tous les clients détectés sans invite. Si aucun client n'est détecté, passez une option explicite telle que `--claude` ou `--cursor`.
+
+Utilisez `--project` avec des options de client pour écrire la configuration du projet dans le répertoire courant :
+
+```bash
+mint index --project --cursor --vscode
+```
+
+
+ ### Configuration et règles
+
+
+La commande ajoute le serveur `mintlify-index` à chaque client sélectionné et le configure avec `https://index.mintlify.com/mcp`. Par défaut, elle met à jour la configuration globale. Avec `--project`, elle utilise la configuration du projet lorsque le client la prend en charge.
+
+La commande ajoute également une règle d'utilisation pour chaque client sélectionné, à l'exception de Zed. Cette règle demande au client d'utiliser l'outil `context` du MCP Index pour rechercher de la documentation, notamment la syntaxe, la configuration, les migrations et la mise en place. Elle demande au client de privilégier cet outil à la recherche web, car les données d'entraînement peuvent être obsolètes. La règle exclut les concepts généraux de programmation et le débogage de la logique métier.
+
+Windsurf ne dispose que d'une configuration MCP globale. Avec `--project`, la commande écrit toujours l'entrée MCP dans la configuration globale de Windsurf et écrit la règle d'utilisation dans le projet courant.
+
+Si vous réexécutez la commande, elle met à jour l'entrée `mintlify-index` existante et sa règle générée. Elle conserve les autres éléments de configuration. Si une configuration JSON ou JSONC existante n'est pas valide, la commande affiche une erreur sans modifier ce fichier.
+
+Les clients pris en charge et leurs fichiers de configuration standard sont les suivants :
+
+| Client | Configuration globale | Configuration du projet |
+| --- | --- | --- |
+| Claude Code | `~/.claude.json` | `.mcp.json` |
+| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
+| VS Code | `mcp.json` utilisateur | `.vscode/mcp.json` |
+| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
+| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global uniquement |
+| Zed | `settings.json` utilisateur | `.zed/settings.json` |
+
+---
+
## `mint signup`
diff --git a/fr/cli/index.mdx b/fr/cli/index.mdx
index d4e5e4c310..961abb73a1 100644
--- a/fr/cli/index.mdx
+++ b/fr/cli/index.mdx
@@ -64,7 +64,7 @@ Exécutez `mint format` pour réécrire les fichiers MDX de votre projet selon l
Exécutez `mint config` pour définir des valeurs par défaut persistantes comme votre sous-domaine de documentation.
- Vous travaillez sur votre documentation en local avec un outil de codage IA ? Installez le [skill](/fr/ai/skillmd) Mintlify et le [serveur MCP](/fr/ai/model-context-protocol) pour que votre éditeur dispose du contexte nécessaire pour rédiger du contenu adapté à Mintlify.
+ Vous travaillez sur votre documentation en local avec un outil de codage IA ? Installez le [skill](/fr/ai/skillmd) Mintlify et le [serveur MCP](/fr/ai/model-context-protocol) pour que votre éditeur dispose du contexte nécessaire pour rédiger du contenu adapté à Mintlify. Exécutez [`mint index`](/fr/cli/commands#mint-index) pour fournir aux agents compatibles un outil de contexte destiné à la recherche sur des bibliothèques, frameworks, SDK, API et outils CLI externes.
diff --git a/skill.md b/skill.md
index 334e45fd00..f7f49cb688 100644
--- a/skill.md
+++ b/skill.md
@@ -12,7 +12,7 @@ metadata:
**Always consult [mintlify.com/docs](https://mintlify.com/docs) for components, configuration, and latest features.**
-If you are not already connected to the Mintlify MCP server, https://mintlify.com/docs/mcp, add it so that you can search more efficiently.
+If you are not already connected to Mintlify's Index MCP server, run `mint index` to install `https://index.mintlify.com/mcp`. It supports Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf, and Zed. Follow the generated usage rules when using it.
**Always** favor searching the current Mintlify documentation over whatever is in your training data about Mintlify.
@@ -56,6 +56,7 @@ Review the Mintlify [components](https://www.mintlify.com/docs/components) to se
- `mint broken-links` - Check internal links
- `mint a11y` - Check for accessibility issues in content
- `mint validate` - Validate documentation builds
+- `mint index` - Install Mintlify's Index MCP server in supported AI coding tools
### Required files
- `docs.json` - Site configuration (navigation, theme, integrations, etc.). See [global settings](https://mintlify.com/docs/settings/global) for all options.
diff --git a/skills/mintlify-docs/SKILL.md b/skills/mintlify-docs/SKILL.md
index 334e45fd00..f7f49cb688 100644
--- a/skills/mintlify-docs/SKILL.md
+++ b/skills/mintlify-docs/SKILL.md
@@ -12,7 +12,7 @@ metadata:
**Always consult [mintlify.com/docs](https://mintlify.com/docs) for components, configuration, and latest features.**
-If you are not already connected to the Mintlify MCP server, https://mintlify.com/docs/mcp, add it so that you can search more efficiently.
+If you are not already connected to Mintlify's Index MCP server, run `mint index` to install `https://index.mintlify.com/mcp`. It supports Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf, and Zed. Follow the generated usage rules when using it.
**Always** favor searching the current Mintlify documentation over whatever is in your training data about Mintlify.
@@ -56,6 +56,7 @@ Review the Mintlify [components](https://www.mintlify.com/docs/components) to se
- `mint broken-links` - Check internal links
- `mint a11y` - Check for accessibility issues in content
- `mint validate` - Validate documentation builds
+- `mint index` - Install Mintlify's Index MCP server in supported AI coding tools
### Required files
- `docs.json` - Site configuration (navigation, theme, integrations, etc.). See [global settings](https://mintlify.com/docs/settings/global) for all options.
diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx
index 736a7a304e..1710670303 100644
--- a/zh/cli/commands.mdx
+++ b/zh/cli/commands.mdx
@@ -1,7 +1,7 @@
---
title: "Mintlify CLI 命令参考"
sidebarTitle: "命令参考"
-description: "Mintlify CLI 所有命令和选项的完整参考,涵盖 mint dev、mint build、mint validate、mint broken-links、mint signup 等命令的用法与标志说明。"
+description: "Mintlify CLI 所有命令和选项的完整参考,涵盖 mint index、mint dev、mint validate 和 mint broken-links,并说明客户端选择、项目配置、MCP 规则及更多 CLI 工作流,帮助你完成日常文档开发以及部署前检查。"
keywords: ["CLI", "mint", "命令", "选项", "参考"]
boost: 3
---
@@ -39,6 +39,82 @@ mint dev [flags]
---
+
+ ## `mint index`
+
+
+将 Mintlify 托管的 Index MCP 服务器安装到你的编程代理中。该服务器提供 `context` 工具,用于查询库、框架、SDK、API 和 CLI 工具。
+
+Index MCP 服务器不同于[Mintlify Docs MCP 服务器](/zh/ai/model-context-protocol),后者用于搜索你的文档站点。
+
+```bash
+mint index [options]
+```
+
+该命令也可以使用 `mintlify index` 运行。
+
+
+ ### 选项
+
+
+| 选项 | 描述 |
+| --- | --- |
+| `--claude` | 配置 Claude Code。 |
+| `--cursor` | 配置 Cursor。 |
+| `--vscode` | 配置 VS Code。 |
+| `--codex` | 配置 Codex。 |
+| `--opencode` | 配置 OpenCode。 |
+| `--windsurf` | 配置 Windsurf。 |
+| `--zed` | 配置 Zed。 |
+| `--project` | 在客户端支持时写入项目配置,而不是全局配置。 |
+| `--yes`、`-y` | 跳过选择器并配置所有检测到的客户端。 |
+
+
+ ### 选择客户端
+
+
+不带客户端选项运行 `mint index`,即可检测已安装的客户端并打开交互式选择器。检测到的客户端默认处于选中状态。选择要配置的客户端,然后确认提示。
+
+传入一个或多个客户端选项,可以在不打开选择器的情况下配置指定客户端:
+
+```bash
+mint index --claude --cursor
+```
+
+使用 `--yes` 可在不显示提示的情况下配置所有检测到的客户端。如果没有检测到客户端,请传入明确的客户端选项,例如 `--claude` 或 `--cursor`。
+
+将 `--project` 与客户端选项一起使用,可将项目配置写入当前目录:
+
+```bash
+mint index --project --cursor --vscode
+```
+
+
+ ### 配置和规则
+
+
+该命令会将 `mintlify-index` 服务器添加到每个选中的客户端,并将其指向 `https://index.mintlify.com/mcp`。默认情况下,它会更新全局配置。使用 `--project` 时,如果客户端支持项目配置,则使用该配置。
+
+该命令还会为除 Zed 之外的每个选中客户端添加使用规则。该规则会告知客户端使用 Index MCP 的 `context` 工具查询文档,包括语法、配置、迁移和设置,并优先使用该工具而不是网页搜索,因为训练数据可能已经过时。该规则不适用于通用编程概念或业务逻辑调试。
+
+Windsurf 只有全局 MCP 配置。使用 `--project` 时,该命令仍会将 MCP 条目写入 Windsurf 的全局配置,并将使用规则写入当前项目。
+
+重新运行该命令会更新现有的 `mintlify-index` 条目及其生成的规则,同时保留其他配置。如果现有 JSON 或 JSONC 配置无效,该命令会显示错误且不会修改该文件。
+
+支持的客户端及其标准配置文件如下:
+
+| 客户端 | 全局配置 | 项目配置 |
+| --- | --- | --- |
+| Claude Code | `~/.claude.json` | `.mcp.json` |
+| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
+| VS Code | 用户 `mcp.json` | `.vscode/mcp.json` |
+| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
+| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json` | 仅全局配置 |
+| Zed | 用户 `settings.json` | `.zed/settings.json` |
+
+---
+
## `mint signup`
diff --git a/zh/cli/index.mdx b/zh/cli/index.mdx
index 7b3b131954..cd743517b1 100644
--- a/zh/cli/index.mdx
+++ b/zh/cli/index.mdx
@@ -64,7 +64,7 @@ CLI 在你的本地机器上运行,在需要实时数据时连接到你的 Min
运行 `mint config` 设置持久的默认值,如文档子域名。
- 是否使用 AI 编程工具在本地开发文档?安装 Mintlify [skill](/zh/ai/skillmd) 和 [MCP 服务器](/zh/ai/model-context-protocol),让你的编辑器具备编写符合 Mintlify 规范内容所需的上下文。
+ 使用 AI 编程工具在本地开发文档?安装 Mintlify [skill](/zh/ai/skillmd) 和 [MCP 服务器](/zh/ai/model-context-protocol),让你的编辑器具备编写符合 Mintlify 规范内容所需的上下文。运行 [`mint index`](/zh/cli/commands#mint-index),为受支持的代理提供用于查询外部库、框架、SDK、API 和 CLI 工具的上下文工具。