Setup Guide

Connect your AI tool to Maindex

Maindex uses the Model Context Protocol (MCP) so any compatible AI client can read and write memories. Most clients support OAuth and will prompt you to log in automatically — just provide the URL below. Pick your tool for step-by-step instructions.

https://maindex.io/mcp

Looking for plugins?

Maindex plugins for Cursor, Claude Code, OpenClaw, Gemini CLI, and ChatGPT bundle the MCP server with curated rules, skills, and an Archivist agent. View Plugins & Apps →

Code Editors

Desktop & CLI

Self-Hosted

Cursor

AI-native code editor with built-in MCP support.

1Open or create your MCP config

Cursor reads MCP servers from a JSON file. Use a project-level file for per-repo config, or a global file for all workspaces.

Scope	Path
Project	.cursor/mcp.json
Global	~/.cursor/mcp.json

2Add the Maindex server

Just provide the URL. Cursor will open a browser window for you to log in via OAuth.

{
  "mcpServers": {
    "maindex": {
      "type": "streamableHttp",
      "url": "https://maindex.io/mcp"
    }
  }
}

If OAuth is unavailable in your environment, use an API key from your dashboard as a fallback.

{
  "mcpServers": {
    "maindex": {
      "type": "streamableHttp",
      "url": "https://maindex.io/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

3Restart Cursor

Fully quit and reopen Cursor. MCP servers are loaded at startup. You can verify the connection under Settings → Tools & MCP.

Cursor MCP documentation →

Claude Desktop

Anthropic's desktop app for Claude.

1Open the config file

Go to Settings → Developer → Edit Config, or open the file directly:

OS	Path
macOS	~/Library/Application Support/Claude/claude_desktop_config.json
Windows	%APPDATA%\Claude\claude_desktop_config.json
Linux	~/.config/Claude/claude_desktop_config.json

2Add the Maindex server

Just provide the URL. Claude Desktop will open a browser window for you to log in via OAuth.

{
  "mcpServers": {
    "maindex": {
      "url": "https://maindex.io/mcp"
    }
  }
}

If OAuth is unavailable in your environment, use an API key from your dashboard as a fallback.

{
  "mcpServers": {
    "maindex": {
      "url": "https://maindex.io/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

3Restart Claude Desktop

Fully quit and reopen the app. Look for the hammer icon in the chat input area to confirm MCP tools are loaded.

Anthropic MCP documentation →

Claude Code

Anthropic's agentic CLI for the terminal.

1Add via CLI

Just provide the URL. Claude Code will open a browser for you to log in via OAuth.

claude mcp add --transport http maindex https://maindex.io/mcp

This saves to the local scope by default (current project). Add --scope user for all projects, or --scope project to commit a shared .mcp.json.

SSH remote sessions

OAuth requires a local browser. If you are using Claude Code over SSH, use the API Key method instead.

Use an API key from your dashboard when OAuth is unavailable (e.g. SSH remote sessions).

claude mcp add --transport http --header "X-API-Key: YOUR_API_KEY" maindex https://maindex.io/mcp

This saves to the local scope by default (current project). Add --scope user for all projects, or --scope project to commit a shared .mcp.json.

2Verify

List your configured servers to confirm:

claude mcp list

Claude Code MCP documentation →

ChatGPT

OpenAI's ChatGPT desktop app with MCP connectors.

1Enable Developer Mode

Open Settings → Apps & Connectors → Advanced settings and toggle Developer Mode on.

2Create a connector

Click Create under Apps & Connectors and fill in:

Field	Value
Connector URL	https://maindex.io/mcp
Name	Maindex
Description	Long-term memory for AI agents

ChatGPT will handle authentication via OAuth automatically — you'll be prompted to log in when you first use the connector.

3Enable in conversations

In any chat, toggle the Maindex connector on in the compose area to give ChatGPT access to your memories.

OpenAI MCP documentation →

Windsurf

Codeium's AI-powered code editor.

1Open the MCP config

Use the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and search for "Windsurf: Configure MCP Servers", or edit the file directly:

OS	Path
macOS / Linux	~/.codeium/windsurf/mcp_config.json
Windows	%USERPROFILE%\.codeium\windsurf\mcp_config.json

2Add the Maindex server

Just provide the URL. Windsurf will open a browser consent screen for you to log in via OAuth.

{
  "mcpServers": {
    "maindex": {
      "serverUrl": "https://maindex.io/mcp"
    }
  }
}

If OAuth is unavailable in your environment, use an API key from your dashboard as a fallback.

{
  "mcpServers": {
    "maindex": {
      "serverUrl": "https://maindex.io/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

3Restart Windsurf

Fully quit and reopen Windsurf. Check the hammer icon in the Chat pane to verify the server is connected.

Windsurf MCP documentation →

Gemini CLI

Google's command-line interface for Gemini.

Recommended: Install the Maindex extension

The Maindex extension for Gemini CLI bundles the MCP server with a context file (GEMINI.md), slash commands, and Archivist behavior. Clone from: git clone https://github.com/maindexapp/gemini-plugin.git

If you prefer a manual MCP-only setup without the extension content, follow the steps below.

1Add via CLI

Just provide the URL. Gemini CLI will open a browser for you to log in via OAuth.

gemini mcp add --transport http maindex https://maindex.io/mcp

This saves to your project-level config at .gemini/settings.json. For global config, edit ~/.gemini/settings.json directly.

If OAuth is unavailable in your environment, use an API key from your dashboard as a fallback.

gemini mcp add --transport http --header "X-API-Key: YOUR_API_KEY" maindex https://maindex.io/mcp

Or edit the JSON config directly:

{
  "mcpServers": {
    "maindex": {
      "url": "https://maindex.io/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Gemini CLI documentation →

Google Antigravity

Google's agent-first IDE for natural-language development.

1Open MCP config

Click the three dots (…) in the top-right corner of Antigravity, then select MCP Servers. Click Manage MCP Servers → View raw config to open the JSON editor.

2Add the Maindex server

Just provide the URL. Antigravity will handle OAuth authentication automatically.

{
  "mcpServers": {
    "maindex": {
      "url": "https://maindex.io/mcp"
    }
  }
}

If OAuth is unavailable in your environment, use an API key from your dashboard as a fallback.

{
  "mcpServers": {
    "maindex": {
      "url": "https://maindex.io/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

3Refresh

Use the refresh button in the MCP Servers panel to verify the connection. Maindex tools will appear when you use the @ prompt.

Google Antigravity →

LM Studio

Run local models with MCP tool support.

1Open the MCP config

LM Studio reads MCP servers from a JSON file. Open it via the in-app MCP editor, or edit the file directly:

OS	Path
macOS / Linux	~/.lmstudio/mcp.json
Windows	%USERPROFILE%\.lmstudio\mcp.json

2Add the Maindex server

LM Studio does not yet support OAuth for remote MCP servers, so an API key is required. Create one in your dashboard and paste it below.

{
  "mcpServers": {
    "maindex": {
      "url": "https://maindex.io/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

3Verify

LM Studio auto-reloads when you save mcp.json. Make sure you are using a tool-capable model (Llama 3.1+, Mistral, Qwen 2.5, etc.) for MCP tools to appear.

LM Studio MCP documentation →

Open WebUI

Self-hosted web interface for Ollama and other backends.

1Open External Tools settings

Go to Admin Settings → External Tools. Requires Open WebUI v0.6.31 or later.

2Add the Maindex server

Enter the URL and select OAuth 2.1 as the auth type. Open WebUI will handle the OAuth flow automatically.

Field	Value
Server URL	https://maindex.io/mcp
Type	MCP (Streamable HTTP)
Auth	OAuth 2.1

If OAuth is unavailable, create an API key in your dashboard and use it as a Bearer token.

Field	Value
Server URL	https://maindex.io/mcp
Type	MCP (Streamable HTTP)
Auth	Bearer Token
Token	YOUR_API_KEY

3Enable in chats

Click + (Add Server), then enable the Maindex tools in individual chats. Note: OAuth-connected tools must be enabled manually per chat and cannot be set as defaults.

Docker note

If Open WebUI runs in Docker and you are connecting to a local Maindex instance, use http://host.docker.internal:PORT/mcp instead of localhost. Set the WEBUI_SECRET_KEY environment variable to prevent token errors on container restart.

Open WebUI MCP documentation →

Msty

Desktop AI app with MCP Toolbox support.

1Open the Toolbox

In Msty, open the Toolbox and click Add New Tool.

2Add as an HTTP server

Msty does not yet support OAuth for remote MCP servers, so an API key is required. Create one in your dashboard.

Field	Value
Type	HTTP
MCP Server URL	https://maindex.io/mcp
Header name	X-API-Key
Header value	YOUR_API_KEY

3Verify

Maindex tools should appear in your Toolbox. Make sure Msty Sidecar is running if you are using Msty Studio Web.

Msty Toolbox documentation →

OpenClaw

Open-source autonomous AI agent platform.

Recommended: Install the Maindex plugin

The Maindex native plugin for OpenClaw bundles MCP integration with OAuth, skills, and Archivist behavior. Clone from: git clone https://github.com/maindexapp/openclaw-plugin.git

If you prefer a manual MCP-only setup without the plugin, you can use the community bridge plugin below.

1Install the MCP Bridge plugin

For a manual connection without the native Maindex plugin, the community openclaw-mcp-bridge plugin provides Streamable HTTP transport.

2Configure the bridge

Add Maindex to your ~/.openclaw/openclaw.json:

{
  "plugins": {
    "enabled": true,
    "entries": {
      "openclaw-mcp-bridge": {
        "config": {
          "servers": [
            {
              "name": "maindex",
              "url": "https://maindex.io/mcp",
              "prefix": "maindex",
              "healthCheck": true
            }
          ],
          "timeout": 30000
        }
      }
    }
  }
}

Then restart the gateway:

openclaw gateway restart && openclaw mcp list

3Authentication

The bridge plugin passes headers to the remote server. Create an API key in your dashboard and configure it according to the bridge plugin docs.

OpenClaw MCP documentation →

Don't see your tool?

Maindex works with any MCP client that supports Streamable HTTP. Point it at your MCP URL and authenticate via OAuth or API key. If you'd like us to add instructions for your tool, let us know.

Authentication

OAuth (recommended) — Most MCP clients support OAuth and will prompt you to log in via your browser automatically. Just provide the MCP URL with no extra configuration. Maindex publishes standard .well-known/oauth-protected-resource and .well-known/oauth-authorization-server discovery endpoints so clients can find the authorization server on their own.

API Key (fallback) — If your client does not support OAuth, or you are in a headless/remote environment without a browser, create an API key in your Maindex dashboard under Settings → API Keys and pass it via the X-API-Key header.