Installation Guide
Get Cortex MCP up and running in under 5 minutes
Choose Your Installation Method
Fastest Way to Get Started
Just copy and paste one command. Works on macOS, Linux, and Windows.
macOS / Linux
curl -sSL https://raw.githubusercontent.com/syab726/cortex/main/scripts/install.sh | bash
Windows (PowerShell)
irm https://raw.githubusercontent.com/syab726/cortex/main/scripts/install.ps1 | iex
Note: The installer will automatically:
- Check Python 3.11+ is installed
- Install cortex-mcp via pip
- Configure Claude Code's mcp.json
- Verify the installation
First Use: Project Initialization
When you start a conversation in a new project, Cortex will ask you to choose a scan mode:
[CORTEX_INIT_PROTOCOL]
Cortex detected a new project. Choose initial scan mode:
1. [FULL] - Deep analysis (recommended for complex projects)
2. [LIGHT] - Quick scan (README, config, entry points)
3. [NONE] - Skip scanning
FULL Mode
Complete codebase analysis. Best for long-term projects. Takes more time initially.
LIGHT Mode (Recommended)
Scans key files only. Fast startup. Good for most projects.
NONE Mode
No initial scan. Context builds organically as you work.
Troubleshooting
Python version error
If you see "Python 3.11+ required":
# Check your Python version
python3 --version
# Install Python 3.11+ from python.org if needed
MCP server not loading
If Cortex doesn't appear in Claude Code:
- Check ~/.claude/mcp.json syntax is valid JSON
- Verify cortex-mcp is installed:
pip show cortex-mcp - Run
claude --mcp-restart - Try
claude mcp listto see registered servers
Permission errors on macOS/Linux
If you see permission denied errors:
# Use pip with --user flag
pip install --user cortex-mcp
# Or use a virtual environment
python3 -m venv ~/.cortex-venv
source ~/.cortex-venv/bin/activate
pip install cortex-mcp