agentleFS
Sign inStart free
hyperbolictonichyperbolictonic/hypagon/AGENTS.md

hypagon

AGENTS.md2 starsChanged 22 days agoMITView on GitHub

Do not write a path from your machine into any file in this repository. This includes documentation, comments, examples, tests, JSON configs and commit messages. The repository is public. Forbidden examples: Use instead: Absolute paths are resolved at runtime. They are never stored in the repository. Why: a path reveals a username, a folder layout, and sometimes a real email address. It cannot be removed from a public Git history by editing the current file. Check: npm run check:no-local-paths scans…

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

The file

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

3 rules. About 0 are common, 1 is distinctive, and 2 are 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.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Do not write a path from your machine into any file in this repository.

    line 5
  2. Very specific:

    Run npx tsc --noEmit and npm run test:mcp:contract before you commit.

    line 41
  3. Very specific:

    Do not commit build output, runtime data or installer binaries.

    line 42

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

Never publish a local disk path

Do not write a path from your machine into any file in this repository. This includes documentation, comments, examples, tests, JSON configs and commit messages. The repository is public.

Forbidden examples:

  • [drive]:\Users\<name>\... or [drive]:/Users/<name>/...
  • /Users/<name>/... or /home/<name>/...
  • file:///<drive>/Users/<name>/...
  • any path that contains a personal workspace folder (for example, Documents/<workspace>/...)
  • a hard-coded checkout path in a script or an MCP config

Use instead:

  • <repo> or <path-to-repo> in prose
  • relative links (./docs/BUILDING.md, ../electron-builder.json)
  • <userData>, %APPDATA%, ~/, $HOME for per-user locations
  • process.cwd(), app.getAppPath(), app.getPath('userData') in code
  • environment variables such as KUANG_MCP_SERVER or KUANG_REPO

Absolute paths are resolved at runtime. They are never stored in the repository.

Why: a path reveals a username, a folder layout, and sometimes a real email address. It cannot be removed from a public Git history by editing the current file.

Check: npm run check:no-local-paths scans every tracked text file. CI runs the same check on every push and pull request. Do not weaken the patterns to make a file pass; replace the path.

Fix: npm run fix:local-paths rewrites obvious leaks in Markdown (home prefixes, the workspace folder, file:/// URLs). Review the diff; it does not rewrite Git history.

Other house rules

  • stdout in the MCP server is JSON-RPC only. Logs go to data/logs/mcp-server.log.
  • Settings are written over IPC only. Do not add an HTTP route that changes settings.
  • For new transport, session, tunnel, auth or child-process code, apply the NASA/JPL review skill in .agents/skills/NASACodeReview. Treat Blocker findings as merge blockers; legacy findings are warnings unless the change makes them worse.
  • If a review or implementation finds a real problem unrelated to the current task, file it in the GitHub issue queue instead of fixing it on a tangent. Search for an existing issue first; link the issue from the final summary. Related findings — ones the change introduces, worsens, or needs to complete safely — stay in the current task. Only fix an unrelated finding immediately when it is a security or lifecycle problem that the current change would worsen or that blocks safe verification.
  • Run npx tsc --noEmit and npm run test:mcp:contract before you commit.
  • Do not commit build output, runtime data or installer binaries. See .gitignore.

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.

Check your setup, free