agentleFS
maister-devmaister-dev/maister/site-docs/AGENTS.md

maister / site-docs

AGENTS.md10 starsChanged 6 months agoMITView on GitHub

The files under site-docs/ are the public product documentation. They are not generated from, mirrored from, or interchangeable with the engineering notes under /docs. Write for MAIster users, instance operators, integrators, and AI agents helping those people. Do not publish internal milestones, implementation statuses, ADR discussion, database internals, or repository-maintainer procedures unless they are part of a supported public contract. - Store every page as Markdown with title and description frontmatter. - Keep headings descriptive and unique. - Put one…

The file

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

6 rules. About 1 is common, 3 are distinctive, and 2 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    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
  1. Very specific:

    Write for MAIster users, instance operators, integrators, and AI agents helping those people.

    line 9
  2. Distinctive:

    Keep headings descriptive and unique.

    line 17
  3. Distinctive:

    Put one task or concept on one page.

    line 18
  4. Distinctive:

    Prefer stable product terms: project, Flow package, task, Run, workspace, evidence, human-in-the-loop request, review, and promotion.

    line 20
  5. Common:

    Never put secrets in examples.

    line 24
  6. Very specific:

    Run pnpm validate and pnpm links in this package before publishing.

    line 29

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

Public documentation rules

The files under site-docs/ are the public product documentation. They are not generated from, mirrored from, or interchangeable with the engineering notes under /docs.

Audience

Write for MAIster users, instance operators, integrators, and AI agents helping those people. Do not publish internal milestones, implementation statuses, ADR discussion, database internals, or repository-maintainer procedures unless they are part of a supported public contract.

Authoring

  • Store every page as Markdown with title and description frontmatter.
  • Keep headings descriptive and unique.
  • Put one task or concept on one page.
  • State prerequisites, exact inputs, success criteria, and failure signals.
  • Prefer stable product terms: project, Flow package, task, Run, workspace, evidence, human-in-the-loop request, review, and promotion.
  • English and Russian pages are separate authored translations. Update both when a public contract changes.
  • Never put secrets in examples. Refer to environment variables by name.
  • Link to the public documentation, not to internal /docs files.

Verification

Run pnpm validate and pnpm links in this package before publishing. A future cross-artifact check may compare supported public claims with /docs, but that check must not turn either artifact into the source of the other.

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.