ekkOS_docs
5 minute setup

Quick Start

Get ekkOS memory working with Claude Code or Cursor in under 5 minutes.

Prerequisites

  • Node.js 18+ installed
  • Claude Code or Cursor installed
  • ekkOS account (free tier available)
1

Get Your API Key

Sign up and grab your API key from the dashboard

  1. 1Go to platform.ekkos.dev
  2. 2Create an account or sign in with GitHub
  3. 3Navigate to Settings → API Keys
  4. 4Click "Generate New Key"
Get API Key
2

Configure Your AI Tool

Add ekkOS to Claude Code or Cursor

Claude Code

Add to ~/.claude/settings.json:

{
  "mcpServers": {
    "ekkos-memory": {
      "command": "npx",
      "args": ["-y", "@ekkos/mcp-server"],
      "env": {
        "EKKOS_API_KEY": "your_api_key_here"
      }
    }
  }
}

Cursor

Add to .cursor/mcp.json in your project:

{
  "mcpServers": {
    "ekkos-memory": {
      "command": "npx",
      "args": ["-y", "@ekkos/mcp-server"],
      "env": {
        "EKKOS_API_KEY": "your_api_key_here"
      }
    }
  }
}

One-Command Setup (Beta)

Run our setup script to automatically configure your tools:

npx @ekkos/setup
3

Restart Your Tool

The MCP server needs a restart to activate

Important: You must restart Claude Code or Cursor for the MCP server configuration to take effect.

  • Claude Code: Close and reopen your terminal
  • Cursor: Restart the application or reload the window

Verify Connection

Test that ekkOS is working

After restarting, ask your AI to use memory. Try these prompts:

"Search my memory for previous solutions"
"Remember that we use PostgreSQL for the database"
"What patterns do you know about authentication?"
Success Indicators
  • • AI mentions using ekkOS or memory tools
  • • You see tool calls like ekko, crystallize, or reflex
  • • AI recalls information from previous sessions

Using ekkOS Memory

ekko — Search Memory

Search your memory substrate for patterns, solutions, and context.

"Search my memory for how we handled authentication" "What patterns do we have for error handling?" "Find previous solutions to database connection issues"

crystallize — Save Decisions

Permanently save important decisions and patterns.

"Remember that we always use Supabase for auth" "Save this: API routes should return typed responses" "Crystallize this pattern for future reference"

reflex — Validate Suggestions

Check AI suggestions against your established patterns (Hallucination Firewall).

"Before implementing this, check if it aligns with our patterns" "Validate this approach against our history" "Does this suggestion match how we usually do things?"

Troubleshooting

MCP server not loading?

  • • Ensure Node.js 18+ is installed: node --version
  • • Check your config file syntax is valid JSON
  • • Verify your API key is correct
  • • Try running npx @ekkos/mcp-server directly to see errors

AI not using memory tools?

  • • Explicitly ask the AI to "search memory" or "use ekkOS"
  • • Check that the MCP server appears in your tool's MCP list
  • • Restart your AI tool completely (not just reload)

API key issues?

  • • Regenerate your key at platform.ekkos.dev
  • • Check for extra spaces or newlines in the key
  • • Ensure the key is in the correct environment variable

Next Steps