agentleFS
eeaeea/eea.agent.skills/AGENTS.md

eea.agent.skills

AGENTS.md7 starsChanged 6 months agoMITView on GitHub

This file governs how AI agents work when editing the eea.agent.skills repository itself. Note: This is the REPO-LOCAL instruction file. For the organization-wide harness that applies to all EEA projects, see harness/EEA-HARNESS.md. skills/ is auto-generated. Never edit it directly. After any change to src/skills/*/SKILL.md or EEA-OVERRIDES.md, run ./scripts/build.sh and commit the skills/ changes. CI fails if skills/ is out of sync (git status --porcelain skills/ must be clean). The build script also copies references/, DESIGN.md, and assets/ if present. Use…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 10

    Very specific

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

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

    Create skill directory under src/skills/{skill-name}/

    line 57
  2. Very specific:

    Add upstream SKILL.md (if based on upstream source)

    line 58
  3. Very specific:

    Create EEA-OVERRIDES.md with EEA-specific customizations

    line 59
  4. Very specific:

    Add metadata.json with skill metadata

    line 60
  5. Very specific:

    Update catalog.yaml with new skill entry

    line 61
  6. Very specific:

    Verify: check that skills/{skill-name}/SKILL.md was generated correctly and git status shows the expected changes

    line 63
  7. Very specific:

    Update EEA-OVERRIDES.md if upstream changes affect EEA customizations

    line 69
  8. Very specific:

    Update catalog.yaml version if applicable

    line 71
  9. Very specific:

    Two-file overlay: every forked skill keeps upstream in SKILL.md and EEA deltas in EEA-OVERRIDES.md.

    line 108
  10. Very specific:

    After running ./scripts/install.sh (or after any manual changes), verify the installation state:

    line 117

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

EEA Agent Skills Repository

This file governs how AI agents work when editing the eea.agent.skills repository itself.

Note: This is the REPO-LOCAL instruction file. For the organization-wide harness that applies to all EEA projects, see harness/EEA-HARNESS.md.


Prohibited Actions

  • Do not edit harness/EEA-HARNESS.md without explicit user request — that's org-wide policy; changes affect every EEA project
  • Do not commit unmerged upstream changes to src/skills/*/SKILL.md — always run ./scripts/build.sh first
  • Do not delete EEA-OVERRIDES.md files — these contain EEA-specific customizations
  • Do not add new top-level directories without updating this README and the harness routing rules
  • Do not commit secrets in any file, including test fixtures and example configs

Build System

skills/ is auto-generated. Never edit it directly.

# Build a single skill (merges SKILL.md + EEA-OVERRIDES.md → skills/)
./scripts/build.sh docker-expert

# Build all skills (run with no arguments)
./scripts/build.sh

After any change to src/skills/*/SKILL.md or EEA-OVERRIDES.md, run ./scripts/build.sh and commit the skills/ changes. CI fails if skills/ is out of sync (git status --porcelain skills/ must be clean).

The build script also copies references/, DESIGN.md, and assets/ if present.


Validation

# Full health check: repo consistency, catalog sync, agentskills spec compliance
./scripts/verify.sh

# Validate all source and merged skills against the Agent Skills specification
./scripts/validate-skills.sh
  • validate-skills.sh auto-installs skills-ref (PyPI) into a temp venv if agentskills is missing.
  • CI runs both on every PR.

Skill Development Workflow

Adding a New Skill

  1. Create skill directory under src/skills/{skill-name}/
  2. Add upstream SKILL.md (if based on upstream source)
  3. Create EEA-OVERRIDES.md with EEA-specific customizations
  4. Add metadata.json with skill metadata
  5. Update catalog.yaml with new skill entry
  6. Build merged skill: ./scripts/build.sh {skill-name}
  7. Verify: check that skills/{skill-name}/SKILL.md was generated correctly and git status shows the expected changes
  8. Commit: skill: add {skill-name}

Updating an Existing Skill

  1. Sync upstream changes to src/skills/{name}/SKILL.md
  2. Update EEA-OVERRIDES.md if upstream changes affect EEA customizations
  3. Rebuild: ./scripts/build.sh {name}
  4. Update catalog.yaml version if applicable
  5. Commit: skill: update {name} to v{X.Y.Z}

Updating EEA Overrides Only

  1. Edit src/skills/{name}/EEA-OVERRIDES.md
  2. Rebuild: ./scripts/build.sh {name}
  3. Commit: harness: update EEA overrides for {name}

Commit Convention

Use Conventional Commits:

TypeUse For
skill:Adding or updating a skill
harness:Changes to harness/EEA-HARNESS.md or org-wide rules
docs:Documentation updates
build:Build script or CI changes
chore:Maintenance, dependencies, formatting

CI Enforcement

WorkflowTriggerWhat it checks
validate-skills.ymlPush/PR touching skillsskills/ up-to-date, catalog.yaml valid YAML, agentskills validate on all skills, token count warnings
validate-harness.ymlPush/PR touching harnessharness/EEA-HARNESS.md exists, referenced files exist, secret scan
check-changelog.ymlAll PRsCode changes must update CHANGELOG.md (bypass with skip-changelog label)

Repo-Specific Conventions

  • Two-file overlay: every forked skill keeps upstream in SKILL.md and EEA deltas in EEA-OVERRIDES.md. EEA-specific values must never leak into upstream base skills.
  • agents/ is reserved for agentget-compatible sub-agent prompts (*.agent.md), not for tool wiring instructions. Agent profiles live in docs/agent-profiles/.
  • Date-based versioning in CHANGELOG.md (YYYY-MM-DD), not SemVer.
  • graphify-out/ exists locally; only graphify-out/cache/ is gitignored. Do not commit cache artifacts.

Verification

After running ./scripts/install.sh (or after any manual changes), verify the installation state:

# Run the health-check script
./scripts/verify.sh

# Use a specific harness source (e.g. when testing from a local repo)
./scripts/verify.sh --harness-dir /path/to/eea.agent.skills

Exit codes:

  • 0 — all checks passed
  • 1 — failures detected
  • 2 — warnings only (no failures)

Note on AGENTS.md vs opencode.json: ~/.config/opencode/AGENTS.md is for personal global instructions (individual preferences). ~/.config/opencode/opencode.json (instructions array) is for org-wide rules like the EEA harness. Never copy the full EEA harness into AGENTS.md — it will go stale. Always reference the remote URL in opencode.json.


Last updated: 2026-05-21

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.