Recommended: universal installer
Use the universal installer first. It can configure this target for hosted cloud or local Docker Convex and creates config backups before writing.--backend local in Bash or -Backend local in PowerShell. See Local-First Setup.
An MCP server is a tool box your AI can open.
Memory Crystal gives that tool box memory tools like “remember this”, “search old conversations”, and “look inside a knowledge base”.
What this means in practice
There are two MCP server stories in this repo:Current path
packages/mcp-server/- Streamable HTTP MCP
- best for modern MCP-capable clients
Legacy path
mcp-server/- deprecated stdio/HTTP server
- still relevant for older compatibility paths like Claude Desktop
Which clients use which path?
Use the current Streamable HTTP MCP path for:
- Claude Code
- Codex CLI
- Factory Droid
- other clients that support Streamable HTTP MCP
Use the deprecated stdio/HTTP package for:
- Claude Desktop
- older or compatibility-driven setups
CRYSTAL_MCP_MODE=stdio. Reserve http for the explicit local network listener.
How it actually works
The current package (packages/mcp-server) wraps Memory Crystal’s hosted HTTP API and exposes a Streamable HTTP MCP endpoint.
The deprecated package (mcp-server) exposes the older local stdio/HTTP form of the same memory tool surface.
Core tool areas include:
- recall and search
- remember and checkpoint
- wake/trace/stats
- knowledge-base list/query/import
Retrieval contract
crystal_recalland reasoning helpers are graph-aware blended memory lookups.crystal_query_knowledge_baseis the dedicated path for named manuals, voice guides, transcripts, runbooks, and imported reference corpora.crystal_search_messagesis retained transcript search and should be used for exact wording, not broad memory synthesis.crystal_preflightis recall with rule/lesson/decision filters and should includeprojectIdorrepoSlugfor repo-specific work.agentId,channel,projectId, andrepoSlugare scope inputs. Use them whenever the client knows the agent/client/repo boundary.- KB
sourceRolevalues such asvoice_style,persona_guardrail,canonical_reference, andclient_contextare provenance and ranking signals.
Universal installer path
The recommended first install path is the universal installer:Commands / examples
Current package local run example:Common mistakes
- using the deprecated package when a client supports the current HTTP transport
- confusing hosted backend auth with local process config
- documenting Claude Desktop like it uses the same path as Claude Code
Source of truth
Primary files behind this page:packages/mcp-server/README.mdpackages/mcp-server/package.jsonpackages/mcp-server/railway.tomlmcp-server/README.mdmcp-server/src/index.ts