agentleFS
dsifrydsifry/metaswarm/AGENTS.md

metaswarm

AGENTS.md426 starsChanged 6 months agoMITView on GitHub

This project is metaswarm — a multi-agent orchestration framework for Claude Code, Gemini CLI, and Codex CLI. It provides 22 agents, 13 orchestration skills, quality gates, and TDD enforcement. Codex discovers skills by their SKILL.md name field. Invoke with $name syntax. This project uses bd (beads) for issue tracking. Run bd onboard to get started. When ending a work session, you MUST complete ALL steps below. Work is NOT complete until git push succeeds. MANDATORY WORKFLOW: CRITICAL RULES: - Work…

  • Deletes or force-pushes
  • Commits and pushes

The file

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

10 rules. About 0 are common, 7 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    File issues for remaining work: - Create issues for anything that needs follow-up

    line 40
  2. Distinctive:

    Verify: - All changes committed AND pushed

    line 51
  3. Distinctive:

    NEVER stop before pushing - that leaves work stranded locally

    line 56
  4. Distinctive:

    NEVER say "ready to push when you are" - YOU must push

    line 57
  5. Distinctive:

    If push fails, resolve and retry until it succeeds

    line 58
  6. Very specific:

    NEVER: use --no-verify on git commits

    line 66
  7. Distinctive:

    NEVER: use git push --force without explicit user approval

    line 67
  8. Distinctive:

    ALWAYS: follow TDD, STAY within file scope

    line 69
  9. Very specific:

    When external AI tools are configured (.metaswarm/external-tools.yaml), the orchestrator can delegate implementation and review tasks to …

    line 86
  10. Very specific:

    When tasks produce visual output, agents can use $visual-review to capture screenshots via Playwright for visual inspection.

    line 90

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

Agent Instructions

This project is metaswarm — a multi-agent orchestration framework for Claude Code, Gemini CLI, and Codex CLI. It provides 22 agents, 13 orchestration skills, quality gates, and TDD enforcement.

Quick Reference

Codex discovers skills by their SKILL.md name field. Invoke with $name syntax.

InvokePurpose
$startBegin tracked work on a task
$setupInteractive guided setup for a project
$brainstorming-extensionRefine an idea before implementation
$design-review-gateTrigger design review gate (5 reviewers)
$plan-review-gateAdversarial plan review (3 reviewers)
$orchestrated-execution4-phase execution loop per work unit
$pr-shepherdMonitor a PR through to merge
$handling-pr-commentsHandle PR review comments
$create-issueCreate a well-structured GitHub Issue
$statusRun diagnostic checks

BEADS Issue Tracking

This project uses bd (beads) for issue tracking. Run bd onboard to get started.

bd ready              # Find available work
bd show <id>          # View issue details
bd update <id> --status in_progress  # Claim work
bd close <id>         # Complete work
# If a Dolt remote is configured: bd dolt push (local-only workspaces need no sync)

Landing the Plane (Session Completion)

When ending a work session, you MUST complete ALL steps below. Work is NOT complete until git push succeeds.

MANDATORY WORKFLOW:

  1. File issues for remaining work - Create issues for anything that needs follow-up
  2. Run quality gates (if code changed) - Tests, linters, builds
  3. Update issue status - Close finished work, update in-progress items
  4. PUSH TO REMOTE - This is MANDATORY:
    git pull --rebase
    # If a Dolt remote is configured: bd dolt push (local-only workspaces need no sync)
    git push
    git status  # MUST show "up to date with origin"
  5. Clean up - Clear stashes, prune remote branches
  6. Verify - All changes committed AND pushed
  7. Hand off - Provide context for next session

CRITICAL RULES:

  • Work is NOT complete until git push succeeds
  • NEVER stop before pushing - that leaves work stranded locally
  • NEVER say "ready to push when you are" - YOU must push
  • If push fails, resolve and retry until it succeeds

Quality Gates (MANDATORY)

  • After a project-sized design doc is committed -> MUST run $design-review-gate before planning (see the metaswarm plugin's guides/workflow-enforcement.md)
  • After the plan is written -> MUST run $plan-review-gate before writing-plans presents the plan (see the metaswarm plugin's guides/workflow-enforcement.md)
  • TDD is mandatory -> Write tests first, watch them fail, then implement
  • Coverage -> .coverage-thresholds.json is the single source of truth. BLOCKING gate.
  • NEVER use --no-verify on git commits
  • NEVER use git push --force without explicit user approval
  • NEVER self-certify -- the orchestrator validates independently
  • ALWAYS follow TDD, STAY within file scope

Delivery Scope & Review Iteration

Block delivery only for a credible normal-usage failure, a missing or contradictory requirement, a broken key happy path, or an important error or recovery-path failure. Every review finding carries a severity (critical/major/minor/nit); to block, a critical/major finding must also name what it protects (a user scenario, requirement or DoD item). Findings without protects are advisory, not blockers. After each review round the orchestrator decides whether to iterate, advance or escalate:

  • No blocker: yes findings -> PASS, advance. Minor/nit findings become follow-ups (a BEADS task, or a GitHub issue if over a day).
  • Escalate to the human -> the same critical/major finding recurs after a fix attempt for it, two reviewers rate the same finding blocker vs. non-blocker, or the safety cap of 10 rounds is hit.
  • Iterate (fix, re-validate, fresh review) -> this round fixed a critical/major finding, or 2+ independent reviewers reported blockers.
  • Overengineering signal -> restate the DoD and re-classify each blocker against the policy; escalate if any still names a credible scenario, otherwise downgrade them to follow-ups and advance.

These rules apply in order, top to bottom (escalation is checked before iteration). A round that still has a blocker and matches none of them also iterates. If bd is unavailable, list follow-ups in a ### Follow-ups section.

Full policy, finding contract and ordered rule: guides/delivery-scope.md.

External Tools Routing

When external AI tools are configured (.metaswarm/external-tools.yaml), the orchestrator can delegate implementation and review tasks to OpenAI Codex CLI and Google Gemini CLI for cost savings and cross-model adversarial review.

Visual Review

When tasks produce visual output, agents can use $visual-review to capture screenshots via Playwright for visual inspection.

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.