Skip to content

Platform Installers

The mcp-automem CLI provides one-command installers for each supported AI platform. These commands configure the MCP server connection, install memory rules, and set up platform-specific integration files — all without manually editing configuration files.

For initial installation and setup wizard, see Setup & Installation. For configuration details and environment variables, see Configuration Tools.

Each platform installer generates and installs appropriate configuration files for that platform’s MCP server format. The installers read your current AutoMem configuration from the environment or .env file and write the correct JSON, TOML, or Markdown files for each platform.

CommandGenerated FilesConfiguration Location
cursor.cursor/rules/automem.mdc~/.cursor/mcp.json (manual)
claude-codeHook scripts in ~/.claude/hooks/ (SessionStart recall, PostToolUse store tracker; optional Stop nudge via --profile nudged)Merges ~/.claude/settings.json (CLAUDE.md must be appended manually)
codexAGENTS.md updates~/.codex/config.toml (manual)
openclaw<workspace>/skills/automem/SKILL.md + <workspace>/config/mcporter.json (MCP mode); plugin entry in openclaw.json (plugin mode)~/.openclaw/openclaw.json (automatic)
hermesmcp_servers.automem and/or memory.provider in config.yaml, rules in AGENTS.md; provider plugin + .env (provider/both modes)~/.hermes/ (automatic)

Claude Desktop requires manual configuration file editing — there is no one-command installer. The setup wizard prints the configuration snippet after completing setup.

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

Add the automem entry to the mcpServers object in your Claude Desktop config file:

{
"mcpServers": {
"automem": {
"command": "npx",
"args": ["@verygoodplugins/mcp-automem"],
"env": {
"AUTOMEM_API_URL": "http://localhost:8001",
"AUTOMEM_API_KEY": "your-api-key"
}
}
}
}

The command and args launch the MCP server in stdio mode. The env block passes configuration to the server process. Claude Desktop spawns this command when initializing MCP connections.

After editing the config file, restart Claude Desktop for changes to take effect.

Claude Desktop also needs an instruction layer so it knows when to recall and store memories. Add the starter template from templates/CLAUDE_DESKTOP_INSTRUCTIONS.md to Claude Desktop → Settings → Profile → Personal Preferences.

If your MCP server key is not memory, update the pasted tool names to match Claude Desktop’s generated prefix.

The cursor command installs memory rules into the project’s .cursor/rules/ directory as a Cursor-compatible .mdc file.

Terminal window
npx @verygoodplugins/mcp-automem cursor

This creates .cursor/rules/automem.mdc in the current directory with memory operation rules tailored for Cursor’s AI features.

Cursor’s global MCP configuration lives at ~/.cursor/mcp.json. Add the AutoMem server entry:

{
"mcpServers": {
"automem": {
"command": "npx",
"args": ["@verygoodplugins/mcp-automem"]
}
}
}

The .cursor/rules/automem.mdc file installed by the cursor command contains instructions that tell Cursor’s AI how to use AutoMem tools — when to store memories, how to structure recalls, and what context to preserve across sessions. Treat this project file as the source of truth for operational behavior; keep any global Cursor rules thin and cross-project.

The claude-code command is the settings-level install path. It writes hook scripts into ~/.claude/hooks/, merges the six mcp__memory__* tool permissions into ~/.claude/settings.json, and removes retired hook-era files from older installs. It does not write CLAUDE.md — that file must be appended manually. For the recommended plugin path (auto-updating marketplace bundle), see Claude Code.

Terminal window
# Default: SessionStart recall + PostToolUse store tracking (silent session end)
npx @verygoodplugins/mcp-automem claude-code
# Opt in to the visible Stop storage nudge at session end
npx @verygoodplugins/mcp-automem claude-code --profile nudged

This command:

  1. Installs hook scripts into ~/.claude/hooks/:
    • automem-session-start.sh — recalls context at session start
    • automem-track-store.sh — observes store_memory calls (PostToolUse)
    • automem-stop-nudge.sh — optional LLM-judged storage nudge (registered only with --profile nudged)
  2. Merges ~/.claude/settings.json with the six mcp__memory__* tool permissions (the installer template assumes the MCP server key is "memory" — if your ~/.claude.json uses another key such as "automem", rename the server or change the permission prefixes to match)
  3. Removes retired hooks and scripts from older installs (capture-*.sh, session-memory.sh, queue machinery, and their support files)

Storage is LLM-judged — hooks prompt and observe; they never write memories themselves. After running the installer, follow the printed instructions to append the memory rules to ~/.claude/CLAUDE.md manually.

Claude Code reads MCP server configuration from ~/.claude.json:

{
"mcpServers": {
"memory": {
"command": "npx",
"args": ["@verygoodplugins/mcp-automem"],
"env": {
"AUTOMEM_API_URL": "http://localhost:8001",
"AUTOMEM_API_KEY": "your-api-key"
}
}
}
}

The server name (memory above) determines the tool prefix in Claude Code (mcp__memory__*). If you use a different server name, update the six permission entries in ~/.claude/settings.json to match.

The codex command installs AutoMem instructions into the project’s AGENTS.md file, which Codex reads as agent instructions.

Terminal window
npx @verygoodplugins/mcp-automem codex

This updates AGENTS.md in the current directory with memory operation rules for Codex.

Codex uses TOML format for its configuration file at ~/.codex/config.toml. The TOML format is semantically equivalent to the JSON format used by other platforms:

[[mcp_servers]]
name = "automem"
command = "npx"
args = ["@verygoodplugins/mcp-automem"]
[mcp_servers.env]
AUTOMEM_API_URL = "http://localhost:8001"
AUTOMEM_API_KEY = "your-api-key"

Generate the JSON config snippet for your current configuration:

Terminal window
npx @verygoodplugins/mcp-automem config

The openclaw command supports three installation modes. The --mode flag controls which integration is set up.

Terminal window
# Plugin mode (recommended) — native OpenClaw plugin with typed tools
npx @verygoodplugins/mcp-automem openclaw --mode plugin
# MCP mode — mcporter-based setup with typed tools
npx @verygoodplugins/mcp-automem openclaw --mode mcp --workspace ~/clawd
# Legacy skill mode — curl-based fallback
npx @verygoodplugins/mcp-automem openclaw --mode skill --workspace ~/clawd

What each mode installs:

  • Plugin: Registers the AutoMem plugin in plugins.entries.automem within ~/.openclaw/openclaw.json
  • MCP: Creates <workspace>/skills/automem/SKILL.md + <workspace>/config/mcporter.json
  • Skill: Creates <workspace>/skills/automem/SKILL.md with curl-based API reference

All modes automatically update ~/.openclaw/openclaw.json. See the OpenClaw platform guide for full details on each mode.

The hermes command installs AutoMem into the Hermes terminal agent in one of three modes. The default is MCP-only.

Terminal window
# MCP tools only (default)
npx @verygoodplugins/mcp-automem hermes --mode mcp
# Native memory provider — ambient recall via memory.provider
npx @verygoodplugins/mcp-automem hermes --mode provider
# Both — ambient recall plus explicit MCP tools
npx @verygoodplugins/mcp-automem hermes --mode both

What each mode installs:

  • MCP: Registers mcp_servers.automem in ~/.hermes/config.yaml (five mcp_automem_* tools; delete_memory excluded by default)
  • Provider: Sets memory.provider: automem, installs the provider plugin in ~/.hermes/plugins/automem/, and writes ~/.hermes/.env
  • Both: MCP server + provider, with duplicate provider tools disabled (AUTOMEM_HERMES_PROVIDER_TOOLS=false)

All modes also write an AutoMem rules block to ~/.hermes/AGENTS.md. See the Hermes platform guide for verification, recall behavior, and troubleshooting.

For cloud AI platforms that cannot run local processes (ChatGPT, Claude.ai via API, ElevenLabs), AutoMem provides a remote MCP bridge via the mcp-sse-server service.

The mcp-sse-server exposes AutoMem tools over SSE (Server-Sent Events) transport, which is compatible with remote MCP clients. Deploy it alongside the AutoMem backend — see Railway Deployment for the deployment setup.

Configure cloud platforms with the public URL of your deployed mcp-sse-server:

https://your-mcp-bridge.up.railway.app

The following diagram shows how configuration files map to different platforms:

graph TB
    subgraph "JSON Platforms"
        ClaudeDesktop["Claude Desktop<br/>claude_desktop_config.json"]
        CursorIDE["Cursor IDE<br/>~/.cursor/mcp.json"]
        ClaudeCode["Claude Code<br/>~/.claude.json"]
    end

    subgraph "TOML Platforms"
        Codex["OpenAI Codex<br/>~/.codex/config.toml"]
    end

    subgraph "Rule Files"
        CursorRules[".cursor/rules/automem.mdc"]
        ClaudeMD["~/.claude/CLAUDE.md"]
        AgentsMD["AGENTS.md"]
    end

    subgraph "OpenClaw Outputs"
        OpenClawPlugin["plugins.entries.automem<br/>in ~/.openclaw/openclaw.json"]
        OpenClawMCPFiles["&lt;workspace&gt;/skills/automem/SKILL.md<br/>+ &lt;workspace&gt;/config/mcporter.json"]
    end

    subgraph "MCP Server"
        NPX["npx @verygoodplugins/mcp-automem<br/>(stdio transport)"]
        SSE["mcp-sse-server<br/>(SSE transport, cloud platforms)"]
    end

    ClaudeDesktop --> NPX
    CursorIDE --> NPX
    ClaudeCode --> NPX
    Codex --> NPX

    CursorInstaller["cursor command"] --> CursorRules
    ClaudeCodeInstaller["claude-code command"] --> HookScripts["~/.claude/hooks/ + ~/.claude/scripts/"]
    CodexInstaller["codex command"] --> AgentsMD
    OpenClawInstaller["openclaw command"] -->|"--mode plugin"| OpenClawPlugin
    OpenClawInstaller -->|"--mode mcp/skill"| OpenClawMCPFiles

After installing for any platform, verify the MCP connection is working:

  1. Restart the AI platform application
  2. Ask the AI to check memory health: “Check my AutoMem database health”
  3. The AI should call check_database_health and return status information

A successful response looks like:

AutoMem is connected and healthy:
- FalkorDB: connected (0 memories)
- Qdrant: connected
- Enrichment worker: running

Symptom: Claude Desktop reports “Server not found” for AutoMem

Solutions:

  1. Verify the config file path is correct for your OS
  2. Validate JSON syntax (the config file must be valid JSON)
  3. Ensure npx is in the PATH accessible to Claude Desktop
  4. Restart Claude Desktop after config changes

Symptom: AutoMem tools are not available in Cursor

Solutions:

  1. Check ~/.cursor/mcp.json exists and has valid JSON
  2. Ensure AUTOMEM_API_URL and AUTOMEM_API_KEY are available either in ~/.cursor/mcp.json under env or via the inherited process environment
  3. Reload the Cursor window (Cmd/Ctrl+Shift+P → “Reload Window”)

Symptom: Claude Code reports permission errors when calling AutoMem tools

Solutions:

  1. Run npx @verygoodplugins/mcp-automem claude-code to update permissions
  2. Check ~/.claude/settings.json for the automem tool permissions
  3. Add tool allowances manually if needed

Symptom: MCP server starts but cannot reach AutoMem service

Solutions:

  1. Verify AutoMem service is running: curl http://localhost:8001/health
  2. Check AUTOMEM_API_URL is set correctly in .env or platform config env block
  3. For Railway deployments, verify the public URL is accessible