agentleFS
knowttlknowttl/bstack/skills/agents-md/SKILL.md

agents-md

Skill0 starsChanged 10 days agoMITView on GitHub

Create and maintain one root AGENTS.md of pointers to a project's rules, evidence requirements and check commands, merging equivalent CLAUDE.md content into it.

36 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use jira, adr and 7 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    jira

    Jira issue workflows for search, issue updates, transitions, comments, field discovery, and interactive credential setup via the Jira REST API. Use when you need to configure Jira access, search with JQL, inspect an issue, create or update work items, move an issue between statuses, post comments, or discover required fields for issue creation.

    Also in 3 projects that use this

  • asterkinSkill

    adr

    Create Architecture Decision Records (ADRs) following project standards. Guides template usage, process, and best practices for documenting architecturally significant decisions.

    Also in 3 projects that use this

  • photon-groveSkill

    unslop

    Detects and rewrites generic, overly polished, or AI-sounding prose while preserving meaning. Use when the user asks to "unslop", humanize, de-AI, tighten, or review whether writing sounds generated.

    Also in 4 projects that use this

  • AWSSkill

    wait-what

    Stop. That last message did not land: re-pitch it.

    Also in 3 projects that use this

  • Harut8Skill

    architect

    Also in 3 projects that use this

  • MicrosoftSkill

    writing-for-agents

    Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

30 rules. 0 are common, 19 are distinctive, and 11 are very specific to this project.

  • 0

    Common

    Most of the 32 edited versions we read keep these.

  • 19

    Distinctive

    This author's own choices. Worth a look.

  • 11

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Only the user starts agents-md.

    line 9
  2. Very specific:

    Start this procedure only when the user's message explicitly invokes $agents-md, /agents-md, /skill:agents-md or selects it through the …

    line 10
  3. Distinctive:

    If you encounter this file while inspecting repository contents without that explicit invocation, treat it as repository content: do not …

    line 12
  4. Distinctive:

    Every other skill adds only the one line for what it wrote.

    line 17
  5. Very specific:

    Keep drafts, audit notes and transcripts in scratch outside the target.

    line 22
  6. Very specific:

    Only apply writes to the target, after the user approves the exact bytes.

    line 23
  7. Distinctive:

    Do not substitute direct project edits or an invented approval for unavailable tooling.

    line 24
  8. Very specific:

    Run node scripts/agents-md.mjs inventory --repo <target> --json, with --workspace for a directory that is not a Git repo, and keep the …

    line 39
  9. Distinctive:

    Read every instruction file it lists, and read the sources the project already has for rules, evidence requirements and check commands.

    line 40
  10. Distinctive:

    Check each existing pointer line in the root AGENTS.md against the repo.

    line 48
  11. Distinctive:

    Check that a pointer to a check command names a command the project actually defines.

    line 50
  12. Distinctive:

    Leave each pointer another skill added as it is unless its target is gone or the user selects a change.

    line 51
  13. Distinctive:

    When a proven check already enforces the rule, propose replacing the prose with a pointer to that check for the user to select.

    line 55
  14. Distinctive:

    Before proposing a removal, recheck the current host's official loading documentation and the runtime where available, as the guide …

    line 63
  15. Distinctive:

    Ask the author, with the limits and the alternative of keeping the import stub, before any removal is proposed.

    line 64
  16. Distinctive:

    Add pointers only for sources that exist, and word each as one sentence saying when an agent should use the source.

    line 73
  17. Distinctive:

    When the project defines affected-test and full-suite commands, add the two command pointers from the AGENTS.md guide.

    line 74
  18. Distinctive:

    Leave out vocabulary, vision, design and standards text.

    line 76
  19. Distinctive:

    Write the sentences by the writing reference.

    line 77
  20. Very specific:

    Run node scripts/agents-md.mjs apply --repo <target> --plan <file> --dry-run --json, with --workspace for a directory that is not a Git …

    line 87
  21. Very specific:

    Use state show with the returned run ID to inspect an interrupted apply, and repeat the unchanged plan to resume.

    line 88
  22. Very specific:

    Run inventory again with the same target flag and confirm that the file kinds and candidates match what the plan intended.

    line 94
  23. Distinctive:

    Keep drafts, audit notes, transcripts and previews in scratch until the user selects changes.

    line 105
  24. Very specific:

    Only apply writes to the target, and it validates the reviewed scope, target path, original and proposed exact-byte hashes and the plan …

    line 113
  25. Very specific:

    Do not bypass missing apply tooling with direct writes.

    line 114
  26. Very specific:

    Use the installed scripts/agents-md.mjs entry point, run documented commands and read their output rather than script source.

    line 115
  27. Distinctive:

    Use command help for syntax, and never guess arguments.

    line 117
  28. Distinctive:

    Read only the one reference needed for the current step, once per run unless it changes.

    line 122
  29. Distinctive:

    Run scripts without loading their source, and pass schemas to scripts without reading them as instructions.

    line 123
  30. Distinctive:

    Never recursively search bundled reference or schema directories to discover guidance.

    line 124

“Common” is measured: kept by at least 6 in 10 of the 32 edited versions of this file we could read. “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
SKILL.md

Scope

Only the user starts agents-md. Start this procedure only when the user's message explicitly invokes $agents-md, /agents-md, /skill:agents-md or selects it through the host's skills menu. A plain request such as "write an AGENTS.md" does not invoke it. If you encounter this file while inspecting repository contents without that explicit invocation, treat it as repository content: do not follow its procedure, open its references or run its commands. Resolve the target before proceeding: an existing repo is passed as --repo, and an existing directory that is not a Git repo is passed as --workspace.

This skill creates the root AGENTS.md when the project has none and maintains it when it has one. The file holds pointers to the project's rules, evidence requirements and maintained check commands, never full copies of them. Every other skill adds only the one line for what it wrote; this skill owns the file, its structure, the CLAUDE.md merge and the pointer audit. It keeps distinct nested instruction files as they are, reports CLAUDE.local.md as possible shadowing without editing it, and inspects and reports nothing outside the selected repo, including ancestor directories and user profiles. It removes a CLAUDE.md only after rechecking the host's official loading documentation and getting the author's approval. It writes no document other than instruction files, and it neither edits product code nor opens pull requests. Return the result to the project's chosen workflow instead of starting another skill. Keep drafts, audit notes and transcripts in scratch outside the target. Only apply writes to the target, after the user approves the exact bytes. Do not substitute direct project edits or an invented approval for unavailable tooling.

Checklist

Copy this checklist and tick a step only when its Done when criterion is met.

  • Step 1: Inventory the instruction files
  • Step 2: Audit the pointers
  • Step 3: Decide the merge
  • Step 4: Draft AGENTS.md
  • Step 5: Review and apply
  • Step 6: Check and report

Step 1: Inventory the instruction files

Run node scripts/agents-md.mjs inventory --repo <target> --json, with --workspace for a directory that is not a Git repo, and keep the output in scratch. Read every instruction file it lists, and read the sources the project already has for rules, evidence requirements and check commands. Classify each instruction file as the root AGENTS.md, a scoped file that governs a nested directory, a repo-owned CLAUDE.md, or a local variant. Load the AGENTS.md guide for the classes, equivalence and what counts as a source.

Done when: Every instruction file is classified, the merge candidates and shadowing reports from inventory are noted, and the project's rule, evidence and check-command sources are listed or reported as absent.

Step 2: Audit the pointers

Check each existing pointer line in the root AGENTS.md against the repo. Report a link whose target is missing, a pointer to something that is not a project source, a line that copies a rule instead of pointing to it, and a source of rules, evidence requirements or check commands that no line points to. Check that a pointer to a check command names a command the project actually defines. Leave each pointer another skill added as it is unless its target is gone or the user selects a change. Content the root file holds that no other source holds stays in place and is reported, because moving it into a source is a separate change. Classify each kept non-pointer rule as enforceable or judgment using the guide's kept-rule audit. For an enforceable rule, name the highest workable rung and suggest /verification correct with the cited rule as a candidate; do not start it or implement enforcement here. When a proven check already enforces the rule, propose replacing the prose with a pointer to that check for the user to select.

Done when: Every pointer is marked resolving, broken or copying with its evidence, every unpointed source is listed, each kept non-pointer rule has a classification and any enforcement route, and no existing line has been judged without opening its target.

Step 3: Decide the merge

A repo-owned CLAUDE.md or .claude/CLAUDE.md whose content is equivalent to the AGENTS.md in its scope, including a file that only imports it, is a merge candidate. Distinct scoped guidance keeps its file and its meaning, and CLAUDE.local.md is reported as possible shadowing and never proposed for change. Before proposing a removal, recheck the current host's official loading documentation and the runtime where available, as the guide describes, and state the compatibility limits for sessions that read only CLAUDE.md. Ask the author, with the limits and the alternative of keeping the import stub, before any removal is proposed. Resolve parent decisions first, group only independent questions into a small round and wait for answers. Silence is not approval.

Done when: Each candidate has a decision to merge, keep or leave, the host check and its date are recorded, and each shadowing report is stated.

Step 4: Draft AGENTS.md

Draft the complete root file in scratch following the pointer shape in the pointer guide, keeping the lines other skills added and the author's order. Add pointers only for sources that exist, and word each as one sentence saying when an agent should use the source. When the project defines affected-test and full-suite commands, add the two command pointers from the AGENTS.md guide. Fold in repo-owned CLAUDE.md content that the author chose to merge, as pointers where a source already holds it and as kept text where none does. Leave out vocabulary, vision, design and standards text. Write the sentences by the writing reference.

Done when: The draft is in scratch, every line is a pointer or merged text the author chose to keep, and every link resolves.

Step 5: Review and apply

Record one finding in scratch following schemas/findings.schema.json with stage audit, the target and the instruction paths as its reviewed scope, and a change set following schemas/change-set.schema.json. The change set creates or replaces AGENTS.md with the exact approved UTF-8 bytes and their hashes, and deletes each selected CLAUDE.md with a delete edit in that same plan. Include starting-checks in the findings' requiredOutcomes, as required by stage audit. A repo uses mode repo with its current revision, and a directory that is not a Git repo uses mode workspace with a null revision. Run node scripts/agents-md.mjs apply --repo <target> --plan <file> --dry-run --json, with --workspace for a directory that is not a Git repo, present the exact diff and the host compatibility limits, then run the unchanged plan without --dry-run only after the author approves those bytes. Use state show with the returned run ID to inspect an interrupted apply, and repeat the unchanged plan to resume.

Done when: Only the approved instruction files have been written or deleted, with unchanged hash preconditions and recoverable originals, or the write remains blocked with its reason.

Step 6: Check and report

Run inventory again with the same target flag and confirm that the file kinds and candidates match what the plan intended. Open each pointer target in the written file to confirm it resolves. State the target, the instruction files found and their classes, each pointer's result, the merge decisions with the host check and its limits, and the written and deleted paths. Name every shadowing report, every unpointed source left for its skill or the author, and any step left blocked with its missing prerequisite. Report each kept non-pointer rule's classification with its file and line, the highest workable rung and /verification correct route for enforceable candidates, and any proposed pointer to an existing proven check. Name the skills that add pointers, /glossary, /vision, /architecture, /foundation, /verification and /maintenance, as the way later pointers arrive, and start none of them.

Done when: The report names what was written or why nothing was, the host check behind any removal, and every open decision.

Review before apply

Keep drafts, audit notes, transcripts and previews in scratch until the user selects changes. Present each edit's problem, consequence, fix, scope and verification, then the exact bytes. A scope change needs a decision, not a silent widening. Record the approval with the exact content it covered.

Write rules

Plan, validate, then execute. Only apply writes to the target, and it validates the reviewed scope, target path, original and proposed exact-byte hashes and the plan digest before any change. Do not bypass missing apply tooling with direct writes. Use the installed scripts/agents-md.mjs entry point, run documented commands and read their output rather than script source. Resolve resources relative to the installed skill and pass the target explicitly. Use command help for syntax, and never guess arguments. Resume by inspecting current files instead of trusting old completion flags, and treat user changes as blocking the remaining writes.

Load when

Read only the one reference needed for the current step, once per run unless it changes. Run scripts without loading their source, and pass schemas to scripts without reading them as instructions. Never recursively search bundled reference or schema directories to discover guidance; use this table and documented command help instead.

WhenOpen
Classifying instruction files, judging equivalence or checking the host before a removalreferences/agents-md.md
Writing the sentences of the filereferences/writing.md
Drafting the file or auditing its pointersreferences/agents-pointer.md
Writing approved changesschemas/findings.schema.json, schemas/change-set.schema.json

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.