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

# 将 Mintlify Index 连接到你的编码代理

> 通过 CLI 或手动配置，在 Claude Code、Cursor、VS Code、Codex、OpenCode、Windsurf 或 Zed 中设置 Mintlify Index MCP 服务器。

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>;
};

将你的编码代理连接到 Mintlify Index，使其可以在规划和编写代码时检索最新的技术文档和 Web 上下文。Index 支持 Claude Code、Cursor、VS Code、Codex、OpenCode、Windsurf 和 Zed。

<Info>
  连接公开的 Index MCP 服务器不需要 Mintlify 账户或 API key。
</Info>

<div id="set-up-with-the-cli">
  ## 使用 CLI 设置
</div>

运行 Index 设置命令，即可在一个步骤中配置一个或多个编码代理：

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

该命令会检测已安装的受支持编码代理，并提示你选择要配置的代理。对于每个选中的代理，它会将 Index MCP 服务器添加到该代理的配置中，并安装一条规则，告诉代理何时使用 `context` 工具。

要跳过选择器，请改为传入一个或多个代理标志：

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

| 标志           | 编码代理        |
| ------------ | ----------- |
| `--claude`   | Claude Code |
| `--cursor`   | Cursor      |
| `--vscode`   | VS Code     |
| `--codex`    | Codex       |
| `--opencode` | OpenCode    |
| `--windsurf` | Windsurf    |
| `--zed`      | Zed         |

<Tip>
  添加 `--yes` 可在不提示的情况下配置检测到的所有代理，或添加 `--project` 将配置写入当前项目，而不是全局代理设置。并非所有代理都支持项目级配置；这些代理始终会接收全局配置。
</Tip>

再次运行该命令即可更新现有设置或添加其他代理。

<div id="set-up-manually">
  ## 手动设置
</div>

要手动配置 Claude Code 或 Cursor，或确认 CLI 所做的更改，请按照对应代理的步骤操作。

<Tabs>
  <Tab title="Claude Code" icon="terminal">
    <Steps>
      <Step title="添加服务器">
        运行以下命令：

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

      <Step title="验证连接">
        列出已配置的 MCP 服务器：

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

        输出应包含状态为已连接的 `mintlify-index`。
      </Step>
    </Steps>
  </Tab>

  <Tab title="Cursor" icon="mouse-pointer-2">
    选择**在 Cursor 中安装**，检查 MCP 配置，然后批准安装。

    <PreviewButton href="cursor://anysphere.cursor-deeplink/mcp/install?name=mintlify-index&config=eyJ1cmwiOiJodHRwczovL2luZGV4Lm1pbnRsaWZ5LmNvbSJ9">在 Cursor 中安装</PreviewButton>

    也可以手动配置 Cursor：

    <Steps>
      <Step title="打开 MCP 设置">
        1. 使用 <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>（Windows 上为 <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>）打开命令面板。
        2. 搜索**打开 MCP 设置**。
        3. 选择**添加自定义 MCP**，打开 `mcp.json`。
      </Step>

      <Step title="添加 Mintlify Index">
        添加以下服务器：

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

      <Step title="验证连接">
        重新加载 Cursor，然后打开 **Settings → Tools & MCP**（设置 → 工具和 MCP）。`mintlify-index` 服务器应显示为已连接，并且可以使用 `context` 工具。
      </Step>
    </Steps>
  </Tab>
</Tabs>

<div id="use-index-in-a-session">
  ## 在会话中使用 Index
</div>

提出实现问题，并告诉代理在你希望确保它检索最新来源时使用 Index。例如：

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

代理在需要技术上下文时会调用 Index 的 `context` 工具，并在工作中包含返回的来源链接。

<div id="remove-the-connection">
  ## 移除连接
</div>

<Tabs>
  <Tab title="Claude Code" icon="terminal">
    运行以下命令：

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

  <Tab title="Cursor" icon="mouse-pointer-2">
    打开 **Settings → Tools & MCP**（设置 → 工具和 MCP），然后从 `mcp.json` 中删除 `mintlify-index` 条目。
  </Tab>
</Tabs>

对于 VS Code、Codex、OpenCode、Windsurf 或 Zed，请从该代理的 MCP 服务器配置中删除 `mintlify-index` 条目。

有关工具输入和速率限制，请参阅 [Index MCP 参考](/docs/zh/search-index/mcp)。


## Related topics

- [skill.md](/docs/zh/ai/skillmd.md)
- [集成](/docs/zh/organize/settings-integrations.md)
- [使用 Cloudflare Workers 在子路径下部署](/docs/zh/deploy/cloudflare.md)