Skip to content
Merged
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -721,8 +721,8 @@ file. It never searches the working directory for `.env`, and explicit process v
| `ENGRAPHIS_ALLOW_AUTOMATIC_CRITICAL_RETENTION` | `false` | Opt in only when an LLM supervisor may automatically assign the long-lived `critical` class; explicit user-selected critical retention is unaffected |
| `ENGRAPHIS_WHISPER_MODEL` | Not set | Enables local faster-whisper audio/video transcription |
| `ENGRAPHIS_POSTGRES_DSN` | Not set | CLI-only PostgreSQL source; used for the connection and never stored |
| `ENGRAPHIS_POSTGRES_CONNECT_TIMEOUT` | `10` | PostgreSQL introspection connection timeout in seconds (bounded to 1120) |
| `ENGRAPHIS_POSTGRES_STATEMENT_TIMEOUT_MS` | `30000` | Per-introspection PostgreSQL statement timeout in milliseconds (bounded to 1300000) |
| `ENGRAPHIS_POSTGRES_CONNECT_TIMEOUT` | `10` | PostgreSQL introspection connection timeout in seconds (bounded to 1--120) |
| `ENGRAPHIS_POSTGRES_STATEMENT_TIMEOUT_MS` | `30000` | Per-introspection PostgreSQL statement timeout in milliseconds (bounded to 1--300000) |
| `ENGRAPHIS_GRAPH_TOKEN` | Not set | Bearer token for `engraphis-graph-server`; required off-loopback |
| `ENGRAPHIS_GRAPH_HOST` / `ENGRAPHIS_GRAPH_PORT` | `127.0.0.1` / `8720` | Read-only graph/recall server bind address |
| `ENGRAPHIS_LLM_PROVIDER` | `openai` | `openai \| anthropic \| google \| openrouter \| custom` |
Expand All @@ -747,6 +747,12 @@ See `.env.example` for the full variable inventory. Supply those values through
environment or the trusted config file above; copying it to an arbitrary `./.env` does not make
Engraphis load it.

> **Ablation fixture:** `python -m eval.ablation` is an offline deterministic check that prints
> `recall@5` comparisons for vector-only and hybrid retrieval, multi-hop graph arms, and
> retrieval policies, plus ordinary-recall age and semantic-confidence checks. It does not
> produce MRR, hit@5, or ms/query results. Use `python -m eval.reinforcement` for retention
> trajectories, and register evidence before quoting any benchmark results.

---

## Project structure
Expand Down
10 changes: 10 additions & 0 deletions docs/LLM_PROVIDERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,13 @@ server, replacing the path with the one from initialization:
cmd mcp add --scope local --env ENGRAPHIS_DB_PATH=/absolute/path/to/engraphis.db engraphis -- engraphis-mcp
```

Windows: `cmd` may resolve to `cmd.exe` (the built-in Windows command interpreter)
instead of the Command Code CLI. If `cmd mcp list` opens a Windows command-prompt window or
prints `'mcp' is not recognized`, the wrong `cmd` was found on `PATH`. Run `where cmd` and
ensure the Command Code CLI's install directory appears before `C:\Windows\System32`;
otherwise invoke the CLI by its absolute path (e.g.
`C:\Users\you\AppData\Roaming\Python\Scripts\cmd.exe`).

All Command Code options precede the server name, and `--` separates the name from the stdio
command. `engraphis-mcp` runs locally over stdio; normal local use needs no HTTP endpoint or
Engraphis API key.
Expand All @@ -244,6 +251,9 @@ cmd mcp list
cmd mcp get engraphis
```

(If these commands open a Windows command prompt instead of listing MCP servers, follow the
Windows note above -- `cmd` resolved to `cmd.exe`.)

Start a normal Command Code session with `cmd`, open `/mcp`, and confirm that `engraphis` is
connected and exposes tools. Then ask Command Code: "Call `engraphis_stats` and show me the
result." A response with memory counts confirms the end-to-end connection.
Expand Down