Documentation

Quickstart

From zero to your first write/recall. This is the v0 of the docs — the structure grows with the product.

1 · Deploy with the kit

Clone the engine repo and use the per-client installer. It brings up the stack (Postgres/pgvector, Redis, API and gateway), runs migrations and a smoke test.

git clone https://github.com/rubenbolivar/memyx
cd memyx
cp deploy/clients/_template.env deploy/clients/my-client.env
# fill in the descriptor (domain, keys, sizing)
deploy/install.sh my-client

2 · Connect an MCP client

Add Memyx to your MCP client (Claude, IDEs, agents). The gateway routes /mcp and validates the per-tenant API key.

{
  "mcpServers": {
    "memyx": {
      "type": "http",
      "url": "https://your-domain/mcp",
      "headers": { "X-API-Key": "mc_your_key" }
    }
  }
}

3 · First write/recall with the SDK

Install the SDK and point it at your deployment. Write a memory and recall governed context.

from memyx_client import Memyx

mc = Memyx("mc_xxx", tenant_id="my-team", agent_id="agent-1",
           base_url="https://your-domain")
mc.write("Q3 revenue target is $4M.")
print(mc.recall("Q3 target").summary)

What’s next?

For per-agent credentials, scopes and the full API surface, reach out — extended documentation is in the works.

Request a demo