Skip to content

Quickstart

Get the MCP server running locally in a few minutes.

Already have a server endpoint? Go to Install for the binary, then Agent Setup to connect your agent with engram v0.16.0 or later. For standalone Claude Code registration, see the plugin guide. Continue below if you need to provision a server.

  • Qdrant — a running Qdrant instance (gRPC port 6334). The quickest path is Docker:

    Terminal window
    docker network create engram-local
    docker run -d --name engram-qdrant --network engram-local qdrant/qdrant

    This creates a network shared by the two containers. Qdrant is reachable by engram without publishing its port on the host.

  • Embeddings endpoint — an OpenAI-compatible embeddings endpoint. Options:

    • LiteLLM in front of any model
    • OpenAI API directly (set ENGRAM_OPENAI_BASE_URL=https://api.openai.com/v1 and ENGRAM_EMBED_MODEL=text-embedding-3-small)
  • OIDC issuer (optional) — if you want bearer-token enforcement, an OIDC issuer URL. Without one, the server accepts all requests (logged loudly).

Pull and run the latest image from GHCR:

Terminal window
docker run -d \
--name engram \
--network engram-local \
-p 127.0.0.1:8080:8080 \
-e ENGRAM_QDRANT_ADDR=engram-qdrant:6334 \
-e ENGRAM_OPENAI_BASE_URL=http://host.docker.internal:4000 \
-e ENGRAM_EMBED_MODEL=ollama/bge-m3 \
ghcr.io/seanb4t/engram:latest

(host.docker.internal resolves on macOS and Windows; Linux users need --add-host host.docker.internal:host-gateway or replace with the host IP.)

This example binds engram to host loopback for local use. For access from other machines, configure authentication and a protected deployment first; see Configure.

The MCP endpoint is served at http://localhost:8080/mcp by default. Set ENGRAM_MCP_PATH=/ to restore the pre-0.7 behavior where the transport answered at the bare root.

Key environment variables (see Configure for the full list):

Variable What it does
ENGRAM_QDRANT_ADDR Qdrant gRPC address (host:port); default localhost:6334
ENGRAM_OPENAI_BASE_URL Embeddings endpoint (OpenAI-compatible); default http://localhost:4000
ENGRAM_EMBED_MODEL Model name forwarded to the endpoint; default ollama/bge-m3

Once the server is running, install the binary and follow Agent Setup for runtime selection, authentication, and a preview before applying changes. Setup requires engram v0.16.0 or later. The Claude Code Plugin guide also covers standalone registration when no binary is installed.

With the server registered, use store_memory to persist a fact and search_memory to retrieve it. See the Tools reference for full parameter docs.

store_memory — persist a decision, convention, preference, or gotcha
search_memory — semantic search over stored memories