agentleFS
waynesuttonwaynesutton/builder-skills/AGENTS.md

builder-skills

AGENTS.md404 starsChanged 45 days agoApache-2.0View on GitHub

Agent skills for builders shipping Convex apps. This file is context for agents working inside this repo. It also symlinks to CLAUDE.md. Seventeen skills in skills/<name>/. Fourteen cover Convex. Three cover how to run a project: PRD first, docs synced from git evidence, git commands that cannot destroy work. Each skill is a folder with SKILL.md, an agents/openai.yaml for Codex icons, and sometimes a references/ folder that the skill loads on demand. The CLI in bin/cli.js installs skills into .claude/skills,…

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

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

5 rules. About 0 are common, 2 are distinctive, and 3 are 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.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No emojis. No em dashes. No marketing words.

    line 21
  2. Very specific:

    Run npm run check before calling anything done.

    line 23
  3. Very specific:

    After a change, sync task.md, changelog.md, files.md.

    line 28
  4. Very specific:

    Before any git command that could discard work, see skills/git-safety.

    line 29
  5. Distinctive:

    Do not commit, push, publish, tag, or deploy.

    line 30

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

builder-skills

Agent skills for builders shipping Convex apps. This file is context for agents working inside this repo. It also symlinks to CLAUDE.md.

What this repo is

Seventeen skills in skills/<name>/. Fourteen cover Convex. Three cover how to run a project: PRD first, docs synced from git evidence, git commands that cannot destroy work. Each skill is a folder with SKILL.md, an agents/openai.yaml for Codex icons, and sometimes a references/ folder that the skill loads on demand.

The CLI in bin/cli.js installs skills into .claude/skills, .codex/skills, or .agents/skills. Templates in templates/ are starters a user edits. scripts/check-skills.mjs is the lint.

Docs first

For Convex APIs, fetch https://docs.convex.dev/llms.txt and follow the link for the area. Do not rely on memory for method names, validator names, or component APIs. When a skill cites an API, it was checked against that index; keep it that way.

Working on skills

  • Frontmatter is name and description only. name matches the folder.
  • description is third person, says what the skill does, and includes a Use when ... sentence.
  • SKILL.md under 300 lines. Hard limit 500. Deep material goes in references/*.md and gets linked from the body.
  • Code samples use the object form with args and returns validators, withIndex over filter, internal.* for scheduling.
  • No emojis. No em dashes. No marketing words.
  • Adding a skill means updating bin/cli.js, index.js, .claude-plugin/plugin.json, the README table, docs.md, and adding a symlink in .codex/skills/.
  • Run npm run check before calling anything done. It has to pass.

Working on this repo

  • Non trivial work gets a PRD in prds/. See skills/project-workflow.
  • After a change, sync task.md, changelog.md, files.md. See skills/project-docs. Dates come from git log --date=short.
  • Before any git command that could discard work, see skills/git-safety.
  • Do not commit, push, publish, tag, or deploy. Print a suggested commit message and stop.

Layout

skills/<name>/SKILL.md          the skill
skills/<name>/references/*.md   loaded on demand from SKILL.md
skills/<name>/agents/openai.yaml Codex icon metadata
bin/cli.js                      builder-skills CLI
index.js                        programmatic API
scripts/check-skills.mjs        lint, run with npm run check
templates/                      starters installed by install-templates
.claude-plugin/                 plugin.json and marketplace.json for Claude Code
.codex/skills/                  symlinks into skills/ for Codex discovery
command/convex.md               OpenCode slash command
prds/                           PRDs for this repo, lessons.md, archive/

Skills

SkillLoad when
convexConvex task with no closer match
convex-best-practicesreviewing patterns, OCC conflicts, ESLint setup
convex-functionswriting any function in convex/
convex-schema-validatortables, validators, indexes
convex-realtimefrontend subscriptions, optimistic updates
convex-http-actionswebhooks, REST, CORS
convex-file-storageuploads, serving, metadata
convex-cron-jobscrons, scheduled functions
convex-migrationslive schema changes, backfills
convex-agentsAI agents, tools, RAG
convex-component-authoringbuilding a component
convex-security-checkquick pass before merge
convex-security-auditfull review before launch
avoid-feature-creepscope is drifting
project-workflowmulti step work, PRDs, task.md
project-docssyncing changelog, files.md, task.md
git-safetyany git command that could discard work

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.