Documentation

Understand how IndexMind works: concepts, configuration, and technical reference.

Installation

Install the IndexMind MCP server from packages/mcp-server: install dependencies, build, and verify the compiled CLI.

The IndexMind MCP server lives in packages/mcp-server/ of the IndexMind repository. It is a Node.js stdio server you build locally and point your IDE at.

Prerequisites

  • Node.js 20+
  • An IndexMind backend API (production or local)
  • An MCP API key from Settings > MCP / IDE Integration (STARTER and above; OWNER or ADMIN)

Install and build

  1. 1

    Clone or open the repository

    git clone https://github.com/WreckingBallStudioLabs/proj-indexmind.git
cd proj-indexmind
  2. 2

    Install and build the package

    cd packages/mcp-server
npm install
npm run build

    This compiles TypeScript into dist/.

  3. 3

    Verify the build

    node dist/index.js --help

    You should see CLI flags including --api-url, --project-id, --readonly, and --log-level.

The dist/ directory is gitignored. Run npm run build after every git pull before pointing your IDE at the server.

Next steps

Configure your editor in IDE Setup, or review Environment & Flags.