agentleFS
DJ-HuangDJ-Huang/LeafLoom/AGENTS.md

LeafLoom

AGENTS.md6 starsChanged 31 days agoMITView on GitHub

  • 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,700 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 repository2 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow current source code and local instructions, keep changes focused and preserve unrelated changes.

    line 12
  2. Distinctive:

    Run the minimum necessary checks for the changes.

    line 16

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Working Agreements

Core Architecture

  • vault_rag/: local Python service providing file APIs, HTTP MCP, cataloging and retrieval; model and vector tasks run in the separate rag_process process.
  • web/: shared React frontend; Markdown content uses Tiptap/ProseMirror, while source editing uses CodeMirror, with shared document state and undo history.
  • desktop/: Electron loads the same frontend and handles only windows, the tray and system integration. HTML projects run on separate origins, isolated from the management interface.
  • Notes live in user directories; indexes, history and trash live in their .vault-rag/ directory. Browsing and retrieval scopes are independent; retrieval uses only explicitly selected content.

Changes and Delivery

  • Follow current source code and local instructions, keep changes focused and preserve unrelated changes; protect original user files, drafts, version checks and access boundaries.
  • Update documentation when completing a feature: update the usage guides in all three languages for operational changes and the changelogs in all three languages for user-visible changes; update the relevant documentation for entry point, architecture or configuration changes, and adjust the homepages in all three languages when needed.
  • The documentation entry point is docs/README.md, and the guides are docs/{en,zh-CN,ja}/GUIDE.md; add new documents to the index. See docs/ARCHITECTURE.md for architecture details and CONTRIBUTING.md for development conventions.
  • Maintain UI text in vault_rag/locales/messages.tsv and generate language files with scripts/compile_locales.py; do not maintain build artifacts as source.
  • Run the minimum necessary checks for the changes; for documentation-only changes, checking links and diffs is sufficient. Report what changed and what was verified, and never claim that unperformed checks passed.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.