agentleFS
HAX-StudioHAX-Studio/mnemonica/skills/brief-light/SKILL.md

brief-light

Skill3 starsChanged 3 months agoMITView on GitHub

This skill should be used when the user asks for "a quick project brief", "orient me on this project", "give me a fast overview", "catch me up on this codebase", or wants a cheap, fast introduction to what a project is and what systems it has without a deep read of every knowledge/ file.

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 1 is distinctive, and 4 are 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.

  • 4

    Very specific

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

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

    If the user's invocation includes extra wording (for example, "focus the brief on the payments system"), treat it as narrowing which …

    line 13
  2. Very specific:

    Read the module index from .claude/CLAUDE.md.

    line 26
  3. Very specific:

    Check whether <project-root> is inside a git working tree.

    line 40
  4. Very specific:

    No git: if knowledge/.mnemonica-state.json exists, read its last_run_utc for the only freshness signal available.

    line 42
  5. Distinctive:

    Write a real narrative, not a bare list: what the project is (from README plus the module descriptions), what systems it has and roughly …

    line 53

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

Mnemonica: brief-light

Give a real, substantive orientation to a project — not two sentences, but not the full depth of brief-full either — by reading the CLAUDE.md index plus a bounded slice of each module file, so the cost stays predictable regardless of how large any individual module has grown. This skill never writes anything.

If the user's invocation includes extra wording (for example, "focus the brief on the payments system"), treat it as narrowing which modules to cover — it cannot turn this into an unbounded read of every module file in full; that is what brief-full is for.

Step 1: Check whether Mnemonica is installed

Run ${CLAUDE_PLUGIN_ROOT}/scripts/check-index-integrity.sh <project-root>. Exit 2 (NO_MNEMONICA_BLOCK) means there is no index to brief from — tell the user and suggest mnemonica:setup, and stop. Exit 1 means some module files are missing; note which ones, but continue — a brief can still be useful with partial coverage.

Step 2: Read the module index and README

Read the module index from .claude/CLAUDE.md. Read README.md at the project root if it exists, for the project's own framing of what it is (name, purpose, how it runs) — this skill only reads README.md, never writes it, same as every other Mnemonica skill.

Step 3: Read a bounded slice of each module

For each module file that exists on disk, read roughly its first 40 lines (or its first major heading section, whichever is shorter) — not the whole file. This is what keeps brief-light light: cost stays roughly constant per module regardless of how long any one of them has grown. Do not read further just because a file looks interesting; that tradeoff is what brief-full exists for.

Step 4: Check freshness

Check whether <project-root> is inside a git working tree.

  • No git: if knowledge/.mnemonica-state.json exists, read its last_run_utc for the only freshness signal available; otherwise say freshness can't be assessed.
  • Git available: run ${CLAUDE_PLUGIN_ROOT}/skills/audit-light/scripts/diff-since-checkpoint.sh <project-root> purely to read its output — never act on what it reports as changed. Exit 2/3/4 all mean "no reliable freshness signal, docs may not reflect recent work" — say that plainly rather than guessing. On success, read COMMITS_BEHIND and mention it if it is more than a handful of commits.

Step 5: Present the brief

Write a real narrative, not a bare list: what the project is (from README plus the module descriptions), what systems it has and roughly what each does (from the bounded reads), and a one-line freshness caveat if the docs might be behind. Mention at the end that mnemonica:brief-full exists for a deeper read into every module's full content when the light version isn't enough.

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.