# Connect Mintlify Index to your coding agent

> Set up the Mintlify Index MCP server in Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf, or Zed with the CLI or manual configuration.

:::callout{intent="info"}
You do not need a Mintlify account or API key to connect to the public Index MCP server.
:::

## Set up with the CLI

Run the Index setup command to configure one or more coding agents in a single step:

```bash theme={null}
npx mint index
```

The command detects which supported coding agents you have installed and prompts you to select which ones to configure. For each selected agent, it adds the Index MCP server to that agent's configuration and installs a rule telling the agent when to use the `context` tool.

To skip the picker, pass one or more agent flags instead:

```bash theme={null}
npx mint index --claude --cursor
```

| Flag         | Coding agent |
| ------------ | ------------ |
| `--claude`   | Claude Code  |
| `--cursor`   | Cursor       |
| `--vscode`   | VS Code      |
| `--codex`    | Codex        |
| `--opencode` | OpenCode     |
| `--windsurf` | Windsurf     |
| `--zed`      | Zed          |

:::callout{intent="tip"}
Add `--yes` to configure every detected agent without prompting, or `--project` to write the configuration to the current project instead of your global agent settings. Not every agent supports project-level configuration. Those agents always receive the global configuration.
:::

Run the command again to update an existing setup or add another agent.

## Set up manually

To configure an agent manually, or to verify what the CLI changed, follow the steps for your agent.

::::::tabs
:::::tab{title="Claude Code"}
::::steps
:::step{title="Add the server"}
Run the following command:

```bash theme={null}
claude mcp add --transport http mintlify-index https://index.mintlify.com/mcp
```
:::

:::step{title="Verify the connection"}
List your configured MCP servers:

```bash theme={null}
claude mcp list
```

The output should include `mintlify-index` with a connected status.
:::
::::
:::::

:::::tab{title="Cursor"}
Click **Install in Cursor**, review the MCP configuration, and approve the installation.

Install in Cursor

To configure Cursor manually instead:

::::steps
:::step{title="Open MCP settings"}
1. Open the command palette with :kbd[Cmd] + :kbd[Shift] + :kbd[P] (:kbd[Ctrl] + :kbd[Shift] + :kbd[P] on Windows).
2. Search for **Open MCP settings**.
3. Click **Add custom MCP** to open `mcp.json`.
:::

:::step{title="Add Mintlify Index"}
Add the following server:

```json theme={null}
{
  "mcpServers": {
    "mintlify-index": {
      "url": "https://index.mintlify.com/mcp"
    }
  }
}
```
:::

:::step{title="Verify the connection"}
Reload Cursor, then open **Settings → Tools & MCP**. The `mintlify-index` server should show as connected with the `context` tool available.
:::
::::
:::::

:::tab{title="VS Code"}
Add the following server to `mcp.json` in your VS Code user profile folder, or to `.vscode/mcp.json` in your project:

```json theme={null}
{
  "servers": {
    "mintlify-index": {
      "type": "http",
      "url": "https://index.mintlify.com/mcp"
    }
  }
}
```
:::

:::tab{title="Codex"}
Add the following server to `~/.codex/config.toml`, or to `.codex/config.toml` in your project:

```toml theme={null}
[mcp_servers.mintlify-index]
type = "http"
url = "https://index.mintlify.com/mcp"
```
:::

:::tab{title="OpenCode"}
Add the following server to `~/.config/opencode/opencode.json`, or to `opencode.json` in your project:

```json theme={null}
{
  "mcp": {
    "mintlify-index": {
      "type": "remote",
      "url": "https://index.mintlify.com/mcp",
      "enabled": true
    }
  }
}
```
:::

:::tab{title="Windsurf"}
Add the following server to `~/.codeium/windsurf/mcp_config.json`. Windsurf does not support project-level MCP configuration.

```json theme={null}
{
  "mcpServers": {
    "mintlify-index": {
      "serverUrl": "https://index.mintlify.com/mcp"
    }
  }
}
```
:::

:::tab{title="Zed"}
Add the following server to your Zed `settings.json`, or to `.zed/settings.json` in your project:

```json theme={null}
{
  "context_servers": {
    "mintlify-index": {
      "url": "https://index.mintlify.com/mcp"
    }
  }
}
```
:::
::::::

## Use Index in a session

Ask an implementation question and tell your agent to use Index when you want to ensure it retrieves current sources. For example:

```text theme={null}
Use Mintlify Index to find the current recommended way to configure caching in Next.js 16. Cite the sources you use.
```

The agent calls the Index `context` tool when it needs technical context and includes the returned source links in its work.

## Remove the connection

::::tabs
:::tab{title="Claude Code"}
Run the following command:

```bash theme={null}
claude mcp remove mintlify-index
```
:::

:::tab{title="Cursor"}
Open **Settings → Tools & MCP**, then delete the `mintlify-index` entry from `mcp.json`.
:::
::::

For VS Code, Codex, OpenCode, Windsurf, or Zed, remove the `mintlify-index` entry from that agent's MCP server configuration.

See the [Index MCP reference](/guides/agent-ready-content-search-index-mcp) for tool inputs and rate limits.

## Related topics

- [Mintlify CLI command reference](/guides/get-started-cli-commands)
- [SEO](/docs/optimize/seo.md)
- [Collect page feedback from users and AI agents](/docs/optimize/feedback.md)

## Related pages

- [Mintlify Index MCP server](./agent-ready-content-search-index-mcp.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.