agentleFS
pecigonzalopecigonzalo/agent-skills/AGENTS.md

agent-skills

AGENTS.md0 starsChanged 4 months agoMITView on GitHub

This repository is the canonical source for reusable Agent Skills shared across Pi, OpenCode, and compatible agent harnesses. - Store every skill at skills/<name>/SKILL.md. - Keep all references, scripts, assets, and eval inputs within the skill package. - Treat source copies in ~/.pi and ~/.config/opencode as migration inputs, not as files to edit from this repository. - Do not modify client configuration repositories unless the task explicitly asks for a cutover. Every SKILL.md must contain YAML frontmatter followed by Markdown…

The file

Show its rules and text

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

26 rules. About 0 are common, 18 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈18

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    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:

    Keep all references, scripts, assets, and eval inputs within the skill package.

    line 8
  2. Very specific:

    Treat source copies in ~/.pi and ~/.config/opencode as migration inputs, not as files to edit from this repository.

    line 9
  3. Distinctive:

    Do not modify client configuration repositories unless the task explicitly asks for a cutover.

    line 11
  4. Very specific:

    Every SKILL.md must contain YAML frontmatter followed by Markdown instructions.

    line 16
  5. Very specific:

    Keep metadata values as strings and use repository-specific keys only when they add operational value.

    line 24
  6. Very specific:

    Treat allowed-tools as experimental and use the specification's space-separated syntax.

    line 26
  7. Distinctive:

    Use relative paths from the skill root.

    line 28
  8. Distinctive:

    Use the standard optional directories consistently:

    line 30
  9. Distinctive:

    Start from observed expertise, real tasks, corrections, and failure modes.

    line 39
  10. Distinctive:

    Keep a skill to one coherent capability.

    line 40
  11. Very specific:

    Keep SKILL.md below 500 lines and about 5,000 tokens when practical.

    line 42
  12. Distinctive:

    Prefer concise procedures, a clear default, concrete examples, gotchas, and validation loops.

    line 46
  13. Distinctive:

    Avoid menus of equivalent choices.

    line 50
  14. Distinctive:

    Do not embed answers for one task where a reusable method will work.

    line 51
  15. Very specific:

    If the core procedure is portable but a client needs an adapter, keep the core in SKILL.md and put conditional client guidance in a clearly …

    line 59
  16. Very specific:

    If the capability fundamentally depends on one host, say so in compatibility and in the instructions.

    line 61
  17. Distinctive:

    Do not claim portability by replacing concrete tool calls with vague advice.

    line 63
  18. Distinctive:

    Import packages without normalization first.

    line 71
  19. Distinctive:

    Keep each skill name unique across the repository.

    line 73
  20. Distinctive:

    Do not merge related skills solely because their topics overlap.

    line 75
  21. Distinctive:

    Never replace a client's entire skills directory during installation.

    line 77
  22. Distinctive:

    Before finalizing a skill change, verify:

    line 82
  23. Distinctive:

    All relative links and referenced resources exist.

    line 88
  24. Very specific:

    Use the repository task runner or validation script once present.

    line 95
  25. Distinctive:

    Commit it as a working state with a behavior-based conventional commit.

    line 104
  26. Distinctive:

    Do not create standalone summary or planning files unless the user requests them.

    line 107

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

Repository instructions

This repository is the canonical source for reusable Agent Skills shared across Pi, OpenCode, and compatible agent harnesses.

Scope

  • Store every skill at skills/<name>/SKILL.md.
  • Keep all references, scripts, assets, and eval inputs within the skill package.
  • Treat source copies in ~/.pi and ~/.config/opencode as migration inputs, not as files to edit from this repository.
  • Do not modify client configuration repositories unless the task explicitly asks for a cutover.

Skill structure

Every SKILL.md must contain YAML frontmatter followed by Markdown instructions. Follow these rules:

  • name is required, uses lowercase letters, numbers, and hyphens, is at most 64 characters, has no leading, trailing, or consecutive hyphens, and exactly matches the parent directory.
  • description is required, is at most 1,024 characters, and states what the skill helps accomplish and when an agent should load it.
  • Include compatibility only for real environment or client requirements.
  • Keep metadata values as strings and use repository-specific keys only when they add operational value.
  • Treat allowed-tools as experimental and use the specification's space-separated syntax. Confirm the target client supports every declared tool.
  • Use relative paths from the skill root. Keep reference chains shallow.

Use the standard optional directories consistently:

  • references/ for detailed material loaded only under stated conditions.
  • scripts/ for tested, repeatable operations an agent would otherwise recreate.
  • assets/ for templates and static resources used in outputs.
  • evals/ for realistic prompts, expected outcomes, assertions, and fixtures.

Writing skills

  • Start from observed expertise, real tasks, corrections, and failure modes.
  • Keep a skill to one coherent capability; split unrelated administration or domain concerns into separate skills.
  • Keep SKILL.md below 500 lines and about 5,000 tokens when practical.
  • Move conditional detail to focused reference files and state exactly when to read each one.
  • Include only information the agent is likely to miss without the skill.
  • Prefer concise procedures, a clear default, concrete examples, gotchas, and validation loops.
  • Explain why a constraint matters when contextual judgment is safe. Use exact sequences only for fragile or destructive operations.
  • Avoid menus of equivalent choices; provide one default and a brief escape hatch.
  • Do not embed answers for one task where a reusable method will work.

Portability

Classify guidance by capability rather than its source repository.

  • Portable skills must not unconditionally invoke Pi- or OpenCode-specific tools, agent names, task schemas, storage APIs, or configuration paths.
  • If the core procedure is portable but a client needs an adapter, keep the core in SKILL.md and put conditional client guidance in a clearly named reference.
  • If the capability fundamentally depends on one host, say so in compatibility and in the instructions.
  • Do not claim portability by replacing concrete tool calls with vague advice.
  • Preserve useful intent during migration; normalization must not silently remove safety gates, verification steps, or domain-specific corrections.

Editing and migration safety

  • Inventory source and destination packages before importing.
  • Preserve source files and uncommitted source-repository changes.
  • Import packages without normalization first; make semantic changes in a later, reviewable phase.
  • Keep each skill name unique across the repository.
  • Move a skill together with every referenced file.
  • Do not merge related skills solely because their topics overlap. Merge only when evidence shows redundant activation or substantial duplicated procedure.
  • Never replace a client's entire skills directory during installation. Prefer collision-checked, per-skill links with an explicit rollback path.

Validation

Before finalizing a skill change, verify:

  • Frontmatter parses and required fields satisfy the Agent Skills specification.
  • Directory and skill names match and are unique.
  • Descriptions name concrete user intents, include an "even if" clause, and distinguish nearby skills.
  • Compatibility and tool declarations are accurate.
  • All relative links and referenced resources exist.
  • Portable instructions contain no unconditional harness-specific operations.
  • Scripts are self-contained or document dependencies and provide actionable errors.
  • Large skills use progressive disclosure deliberately.
  • Existing evaluations pass, and new behavior has realistic coverage when useful.

Use the repository task runner or validation script once present. Until then, use skills-ref validate skills/<skill-name> where available.

Workflow

For migrations and broad refactors:

  1. Plan the work in independently reviewable phases.
  2. Implement one phase without changing later-phase concerns.
  3. Review and correct that phase.
  4. Commit it as a working state with a behavior-based conventional commit.
  5. Continue only after the phase commit succeeds.

Do not create standalone summary or planning files unless the user requests them. Keep README and repository instructions current instead.

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.