academic-students
AGENTS.md7 starsChanged 5 days agoMITView on GitHub
Briefing for any coding agent working on this repository (Codex, Gemini CLI, Cursor, Copilot, Claude Code, …). The full briefing is CLAUDE.md; it applies to every agent, not only Claude. Read it before changing anything. The essentials: - TDD: a failing test first for every script and for the MCP server; then the code. - Before pushing: python3 tools/sync_shared.py --check && python3 -m pytest -q. - Skills follow the open Agent Skills format: skills/<name>/SKILL.md (frontmatter keys: name, description, license, compatibility,…
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,774 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 repository10 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- academic-writingSkill
- assignment-coachSkill
- assignment-judgeSkill
- exam-prepSkill
- lecture-notesSkill
- moodle-syncSkill
- prompt-injection-scannerSkill
- rtl-writingSkill
- study-plannerSkill
The file
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is 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.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 9
Skills: follow the open Agent Skills format: skills/<name>/SKILL.md (frontmatter keys: name, description, license, compatibility, metadata, …
≈ “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
Briefing for any coding agent working on this repository (Codex, Gemini CLI, Cursor, Copilot, Claude Code, …).
The full briefing is CLAUDE.md; it applies to every agent, not only Claude. Read it before
changing anything. The essentials:
- TDD: a failing test first for every script and for the MCP server; then the code.
- Before pushing:
python3 tools/sync_shared.py --check && python3 -m pytest -q. - Skills follow the open Agent Skills format:
skills/<name>/SKILL.md(frontmatter keys:name,description,license,compatibility,metadata,allowed-toolsonly),references/,scripts/,tests/. Skill bodies name no single agent's product. - Shared knowledge lives in
shared/and is copied into skills bytools/sync_shared.py; never edit the copies. - Never: store or accept a password; call a Moodle function that writes; invent a citation; commit real course material or personal data; run anything that consumes paid model or API usage without the owner's explicit approval.
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.