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.
Set up with the CLI
Section titled “Set up with the CLI”Run the Index setup command to configure one or more coding agents in a single step:
npx mint indexThe 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:
npx mint index --claude --cursor| Flag | Coding agent |
|---|---|
--claude |
Claude Code |
--cursor |
Cursor |
--vscode |
VS Code |
--codex |
Codex |
--opencode |
OpenCode |
--windsurf |
Windsurf |
--zed |
Zed |
Run the command again to update an existing setup or add another agent.
Set up manually
Section titled “Set up manually”To configure an agent manually, or to verify what the CLI changed, follow the steps for your agent.
Add the server
Run the following command:
Bash claude mcp add --transport http mintlify-index https://index.mintlify.com/mcpVerify the connection
List your configured MCP servers:
Bash claude mcp listThe output should include
mintlify-indexwith a connected status.
Click Install in Cursor, review the MCP configuration, and approve the installation.
Install in Cursor
To configure Cursor manually instead:
Open MCP settings
- Open the command palette with Cmd + Shift + P (Ctrl + Shift + P on Windows).
- Search for Open MCP settings.
- Click Add custom MCP to open
mcp.json.
Add Mintlify Index
Add the following server:
JSON { "mcpServers": { "mintlify-index": { "url": "https://index.mintlify.com/mcp" } } }Verify the connection
Reload Cursor, then open Settings → Tools & MCP. The
mintlify-indexserver should show as connected with thecontexttool available.
Add the following server to mcp.json in your VS Code user profile folder, or to .vscode/mcp.json in your project:
{
"servers": {
"mintlify-index": {
"type": "http",
"url": "https://index.mintlify.com/mcp"
}
}
}Add the following server to ~/.codex/config.toml, or to .codex/config.toml in your project:
[mcp_servers.mintlify-index]
type = "http"
url = "https://index.mintlify.com/mcp"Add the following server to ~/.config/opencode/opencode.json, or to opencode.json in your project:
{
"mcp": {
"mintlify-index": {
"type": "remote",
"url": "https://index.mintlify.com/mcp",
"enabled": true
}
}
}Add the following server to ~/.codeium/windsurf/mcp_config.json. Windsurf does not support project-level MCP configuration.
{
"mcpServers": {
"mintlify-index": {
"serverUrl": "https://index.mintlify.com/mcp"
}
}
}Add the following server to your Zed settings.json, or to .zed/settings.json in your project:
{
"context_servers": {
"mintlify-index": {
"url": "https://index.mintlify.com/mcp"
}
}
}Use Index in a session
Section titled “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:
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
Section titled “Remove the connection”Run the following command:
claude mcp remove mintlify-indexOpen 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 for tool inputs and rate limits.