Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.memorycrystal.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use the universal installer first. It can configure this target for hosted cloud or local Docker Convex and creates config backups before writing.

Agent Instructions

Copy and paste this directly into Claude Code:
Install Memory Crystal for Claude Code. Run the official installer command for this machine, follow the auth/backend prompts, and do not manually edit Claude config unless the installer fails and asks for a manual fallback. After installation, reopen Claude Code and confirm Memory Crystal MCP tools are available.

macOS/Linux/WSL:
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets claude-code

Windows PowerShell:
iwr https://memorycrystal.ai/install.ps1 -OutFile install.ps1; .\install.ps1 -Targets claude-code
curl -fsSL https://memorycrystal.ai/crystal | bash -s -- --targets claude-code
For native Windows PowerShell, use:
iwr https://memorycrystal.ai/install.ps1 -OutFile install.ps1
.\install.ps1 -Targets claude-code
For local data storage, add --backend local in Bash or -Backend local in PowerShell. See Local-First Setup. Claude Code can plug into Memory Crystal so it can ask for memories it learned before instead of starting from zero every run.

What this means in practice

Claude Code uses the current Streamable HTTP MCP path. In this repo, that means you can either:
  • run the Claude-specific installer
  • or register the MCP endpoint yourself

How it actually works

Important repo surfaces:
  • apps/web/public/install-claude-mcp.sh
  • packages/mcp-server/README.md
  • .env.example
The installer is responsible for:
  • detecting the Claude CLI
  • handling device/browser authorization or manual API-key entry
  • registering the Memory Crystal MCP endpoint
  • storing local Memory Crystal support files under ~/.memory-crystal

Universal installer path

The recommended first install path is the universal installer:
curl -fsSL https://memorycrystal.ai/crystal | bash
Use it when you want Memory Crystal to detect Claude Code, ask before changing config, and offer cloud or local-first backend mode. The dedicated commands below remain useful for single-client installs and compatibility.

Commands / examples

Installer:
curl -fsSL https://memorycrystal.ai/install-claude-mcp.sh | bash
Direct registration:
claude mcp add memory-crystal --transport http http://localhost:3100/mcp

Uninstall

curl -fsSL https://memorycrystal.ai/uninstall-claude-mcp.sh | bash
For purge behavior and safety notes, see the uninstall guide.

Common mistakes

  • following the deprecated Claude Desktop path instead of the Claude Code path
  • confusing local server examples with hosted endpoint usage
  • forgetting to provide the API key/backend URL when bypassing the installer

Source of truth

Primary files behind this page:
  • apps/web/public/install-claude-mcp.sh
  • packages/mcp-server/README.md
  • .env.example