yantrikdb
AGENTS.md73 starsChanged 4 months agoApache-2.0View on GitHub
Guidance for AI coding agents (Claude Code, Codex, Cursor, and others that read this file) working in this repository. YantrikDB is the Rust cognitive-memory engine behind yantrikdb-server and yantrikdb-mcp. Apache-2.0, no CLA, no copyright assignment. A default cargo build has no network code path: the embedder-download feature is off, so with_default() uses the bundled 64-dim potion-base-2M. The Python wheel turns that feature on, which is why pip users get the 256-dim potion-base-8M default instead. If you're touching embedder code, build…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 33,315 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repositoryOne other file it gives its agents.
- build-packSkill
The file
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 51
Add or extend a test that fails without your change — concurrency and temporal-decay behavior is easy to break by accident.
- Distinctive: line 55
If picking up an existing issue, say so on the issue first.
≈ “Common” is an estimate: at least 1 in 5 of the 42,283 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md
Guidance for AI coding agents (Claude Code, Codex, Cursor, and others that read this file) working in this repository.
What this is
YantrikDB is the Rust cognitive-memory engine behind yantrikdb-server and yantrikdb-mcp. Apache-2.0, no CLA, no copyright assignment.
Setup
git clone https://github.com/yantrikos/yantrikdb
cd yantrikdb
cargo test --workspaceA default cargo build has no network code path: the embedder-download
feature is off, so with_default() uses the bundled 64-dim
potion-base-2M. The Python wheel turns that feature on, which is why pip
users get the 256-dim potion-base-8M default instead. If you're touching
embedder code, build both configurations:
cargo build --features embedder-download
cargo build --no-default-features # slim: no bundled embedder at allPython bindings live in crates/yantrikdb-python (pyo3 + maturin). The
wasm build used by the in-browser demo is crates/yantrikdb-wasm.
Before opening a PR
Both of these must pass — they're also what CI runs:
cargo fmt --all -- --check
cargo clippy --all-targets --all-features --workspace --exclude yantrikdb-python -- --cap-lints warn
cargo test --workspacecargo fmt --all (no --check) and the clippy line above are the two
that fail most often locally; run them before testing.
Conventions
- One logical change per PR, squash-merged into
main(branch-protected). - Add or extend a test that fails without your change — concurrency and
temporal-decay behavior is easy to break by accident; see
CONCURRENCY.mdfor the invariants. - Describe what you observed, not only what you changed.
- If picking up an existing issue, say so on the issue first.
Full contributor guide: CONTRIBUTING.md.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

