# AGENTS.md

The best-benchmarked open-source AI memory system. And it's free.

## Setup

```
uv sync
```

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `tests/`      158 source files
- `mempalace/`  80 source files
- `benchmarks/` 24 source files
- `hooks/`      12 source files
- `website/`    11 source files
- `examples/`   3 source files

## Conventions

- Tests live alongside the code they cover, following `docs/rfcs/001-storage-backend-plugin-spec.md`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `mempalace/mcp_server.py` is 338KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.