agentleFS
ArangoGutierrezArangoGutierrez/claude-toolkit/docs/agents.md

claude-toolkit

AGENTS.md4 starsChanged 3 months agoMITView on GitHub

This page is for an AI agent (or a human scripting one) that wants to pull this repo's documentation into context programmatically, without cloning the repo or rendering the MkDocs site. Every page in this repo is plain Markdown, fetchable directly from GitHub's raw-content host at a predictable URL: For example, this page itself is: No authentication, no rate-limit surprises beyond GitHub's normal unauthenticated raw-content limits, and no HTML to strip — just the source Markdown, exactly as it renders…

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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:

    Every page in this repo is plain Markdown, fetchable directly from GitHub's raw-content host at a predictable URL:

    line 9
  2. Distinctive:

    No authentication, no rate-limit surprises beyond GitHub's normal unauthenticated raw-content limits, and no HTML to strip — just the …

    line 22
  3. Very specific:

    Every page under docs/patterns/ uses the same four H2 headings, in the same order: ## What, ## How, ## Env, ## Pitfalls.

    line 60

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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

Agents

This page is for an AI agent (or a human scripting one) that wants to pull this repo's documentation into context programmatically, without cloning the repo or rendering the MkDocs site.

Raw-md URL scheme

Every page in this repo is plain Markdown, fetchable directly from GitHub's raw-content host at a predictable URL:

https://raw.githubusercontent.com/ArangoGutierrez/claude-toolkit/main/<path>

For example, this page itself is:

https://raw.githubusercontent.com/ArangoGutierrez/claude-toolkit/main/docs/agents.md

No authentication, no rate-limit surprises beyond GitHub's normal unauthenticated raw-content limits, and no HTML to strip — just the source Markdown, exactly as it renders in the MkDocs site.

llms.txt — the root index

llms.txt is a hand-curated index in the llmstxt.org format: an H1 title, a one-line summary, and grouped link lists (## Docs, ## Patterns, ## Examples, ## Engine source), one link per line. Start here if you want to decide which pages are relevant before fetching them — it is small enough to fit in a single context window alongside your own task.

llms-full.txt — the single-fetch corpus

llms-full.txt concatenates every page linked from llms.txt, in the order llms.txt lists them, each preceded by a ===== <path> ===== header. Fetch this one file to get the entire documentation corpus in a single request — useful when you'd rather pay one fetch than N, or when your fetch tool doesn't handle a fan-out well.

It is generated, not hand-written: scripts/gen-llms-full.sh reads llms.txt, resolves every linked .md file back to its path in this repo, and concatenates them. Regenerate it whenever llms.txt changes, or whenever any page it links changes:

scripts/gen-llms-full.sh

The script fails loudly (non-zero exit, MISSING: <path> on stderr) if llms.txt ever links a path that doesn't exist in the tree, so a stale link can't silently ship in the generated corpus.

The stable-heading promise

Every page under docs/patterns/ uses the same four H2 headings, in the same order: ## What, ## How, ## Env, ## Pitfalls. An agent that has parsed one pattern page can jump straight to the section it needs on any other pattern page without re-parsing the whole document — ## Pitfalls always answers "what breaks and why," ## Env always answers "what variables does this read." This structure is a contract: new pattern pages are expected to follow it, and a page that doesn't should be treated as a bug.

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.