knowledge-vault
AGENTS.md3 starsChanged 4 months agoApache-2.0View on GitHub
This file lets any AI coding agent (Claude Code, Codex, Cursor, …) use the vault following the same conventions as the Claude Code plugin. Drop it at your project root. All paths come from .claude/knowledge-base.local.md (YAML frontmatter). Read it first. Required: vault_path. The vault root is vault_path + vault_dir (if set). Defaults: If the file is missing, create it from settings.example.md. Never hardcode a folder name — build every path from these variables. Route by document type: note/reference → notes/…
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 31,542 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 repository3 other files it gives its agents.
- agent-coordinationSkill
- file-namingSkill
- vault-accessSkill
The file
We split this AGENTS.md into the rules it gives an agent
4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 7
All paths come from .claude/knowledge-base.local.md (YAML frontmatter).
- Very specific: line 23
If the file is missing, create it from settings.example.md.
- Very specific: line 41
Versioning: never overwrite a document — create name-v2.md and mark the old one superseded.
- Very specific: line 42
Frontmatter: every document gets YAML frontmatter (title, type, status, created, owner, tags, related).
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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 — knowledge-vault
This file lets any AI coding agent (Claude Code, Codex, Cursor, …) use the vault following the same conventions as the Claude Code plugin. Drop it at your project root.
Config
All paths come from .claude/knowledge-base.local.md (YAML frontmatter). Read it first. Required: vault_path. The vault root is vault_path + vault_dir (if set). Defaults:
vault_path: /path/to/your/vault
vault_dir: ""
task_inbox: tasks/inbox.md
task_todo: tasks/to-do.md
task_in_progress: tasks/in-progress.md
task_done: tasks/done.md
task_cancelled: tasks/cancelled.md
notes_dir: notes
index_file: notes/index.md
vault_title: Knowledge Base
default_owner: ""If the file is missing, create it from settings.example.md. Never hardcode a folder name — build every path from these variables.
Intent → action
| The user wants to… | Do this |
| Find a document | Glob/Grep/Read under the vault root. Check {index_file} first for "does a doc on X exist?" |
| Save pasted text as a doc | Classify the type, write clean markdown with frontmatter to the type's folder (see below), cross-link related docs |
| Save a URL as a note | Fetch, summarize, tag, write to {notes_dir}/{YYYY}/{topic}/YYYY-MM-DD-slug.md |
| Add a task | Append an Obsidian Tasks line to {task_todo} (or {task_inbox}) |
| List tasks | Read the relevant task file(s), parse - [ ] #task … lines, filter |
| Complete a task | Move the line from its current file to {task_done} — move, don't copy |
| Persist a whole session | Synthesize a brief, then file results into the right folders, versioning rather than overwriting |
Conventions
- Links: standard markdown links
[Title](./path.md)only — never wikilinks[[doc]]. - Filenames: lowercase, hyphens, date-front for dated docs (
YYYY-MM-DD-topic.md). See thefile-namingskill for the full rules. - Versioning: never overwrite a document — create
name-v2.mdand mark the old onesuperseded. - Frontmatter: every document gets YAML frontmatter (
title,type,status,created,owner,tags,related).
Default folders (all configurable)
notes/ tasks/ meetings/ people/ policies/ projects/ reference/Route by document type: note/reference → notes/ (or reference/ for standing docs), meeting → meetings/, contact → people/, policy → policies/, project/agreement → projects/, task → tasks/. When unsure, use notes/.
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.