agentleFS
Sign inStart free
SterlingJFSterlingJF/knowledge-bus/docs/AGENTS.md

knowledge-bus

AGENTS.md4 starsChanged 2 months agoMITView on GitHub

Mintlify site for Knowledge Bus. Pages are MDX with YAML frontmatter; navigation, colors and links live in docs.json. Run pnpm dlx mint validate and pnpm dlx mint broken-links from this folder.

  • 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 repository8 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, 1 is distinctive, and 1 is 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.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep the owner-reviewed wording.

    line 13
  2. Very specific:

    Run pnpm dlx mint validate and pnpm dlx mint broken-links from this folder.

    line 19

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

Knowledge Bus docs

Mintlify site for Knowledge Bus. Pages are MDX with YAML frontmatter; navigation, colors and links live in docs.json.

Terminology

  • Knowledge Bus is the project; the Knowledge Bus Protocol is its conformance contract.
  • A universe spec declares knowledge elements, document types and their relations. Say "document type" in prose; "artifact" is the protocol's term.
  • Samples are the universe specs in universe-samples/.

Writing rules

  • Keep the owner-reviewed wording. Change format, links and components, not prose, unless asked.
  • Headings in sentence case. Links to other pages are root-relative with no extension; links to repository files are full GitHub URLs.
  • knowledge-bus-directory.mdx is also bundled into the agent skills as Markdown. Keep it free of components, and keep its links to anchors on the same page.

Checks

Run pnpm dlx mint validate and pnpm dlx mint broken-links from this folder.

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