> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

export const PreviewButton = ({children, href}) => {
  return <a href={href} className="text-sm font-medium text-white dark:!text-zinc-950 bg-zinc-900 hover:bg-zinc-700 dark:bg-zinc-100 hover:dark:bg-zinc-300 rounded-full px-3.5 py-1.5 not-prose">
        {children}
      </a>;
};

Connect your coding agent to Mintlify Index so it can retrieve current technical documentation and web context while it plans and writes code. Index supports Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf, and Zed.

<Info>
  You do not need a Mintlify account or API key to connect to the public Index MCP server.
</Info>

## 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 choose which ones to configure. For each agent you select, 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          |

<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.
</Tip>

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

## Set up manually

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

<Tabs>
  <Tab title="Claude Code" icon="terminal">
    <Steps>
      <Step title="Add the server">
        Run the following command:

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

      <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.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Cursor" icon="mouse-pointer-2">
    Select **Install in Cursor**, review the MCP configuration, and approve the installation.

    <PreviewButton href="cursor://anysphere.cursor-deeplink/mcp/install?name=mintlify-index&config=eyJ1cmwiOiJodHRwczovL2luZGV4Lm1pbnRsaWZ5LmNvbSJ9">Install in Cursor</PreviewButton>

    To configure Cursor manually instead:

    <Steps>
      <Step title="Open MCP settings">
        1. Open the command palette with <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows).
        2. Search for **Open MCP settings**.
        3. Select **Add custom MCP** to open `mcp.json`.
      </Step>

      <Step title="Add Mintlify Index">
        Add the following server:

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

      <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.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## 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" icon="terminal">
    Run the following command:

    ```bash theme={null}
    claude mcp remove mintlify-index
    ```
  </Tab>

  <Tab title="Cursor" icon="mouse-pointer-2">
    Open **Settings → Tools & MCP**, then delete the `mintlify-index` entry from `mcp.json`.
  </Tab>
</Tabs>

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](/docs/search-index/mcp) for tool inputs and rate limits.


## Related topics

- [Collect page feedback from users and AI agents](/docs/optimize/feedback.md)
- [AI-native documentation](/docs/ai-native.md)
- [skill.md](/docs/ai/skillmd.md)