agentleFS
waynesuttonwaynesutton/builder-skills/templates/AGENTS.md

builder-skills / templates

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

[Project name]. [One sentence on what it does and who uses it.] Stack: Convex (backend), [React / Next.js / Vite / Expo] (frontend), [auth provider], [email provider]. For any Convex API, fetch https://docs.convex.dev/llms.txt and follow the link for the area before relying on memory. The skills in .claude/skills/ (or .agents/skills/) cover each area in depth. Load the one that matches the task. Do not run npx convex deploy, git commit, git push, or any publish command unless the current message…

  • Commits and pushes

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

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

  • 5

    Very specific

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

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

    Do not run npx convex deploy, git commit, git push, or any publish command unless the current message asks for it.

    line 23
  2. Very specific:

    Every function uses the object form with args and returns validators.

    line 44
  3. Very specific:

    Keep query / mutation / action wrappers thin.

    line 51
  4. Very specific:

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

    line 56
  5. Very specific:

    Before any git command that could discard work, load the git-safety skill.

    line 57
  6. Distinctive:

    No emojis. No em dashes.

    line 62
  7. Distinctive:

    No placeholder text or images.

    line 64

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

Project context

[Project name]. [One sentence on what it does and who uses it.]

Stack: Convex (backend), [React / Next.js / Vite / Expo] (frontend), [auth provider], [email provider].

Docs first

For any Convex API, fetch https://docs.convex.dev/llms.txt and follow the link for the area before relying on memory. The skills in .claude/skills/ (or .agents/skills/) cover each area in depth. Load the one that matches the task.

Commands

npx convex dev                 # development. watches, syncs, regenerates types
npx convex dev --once          # single sync
npx convex run file:fn '{}'    # run a function with args
npx convex logs                # tail logs
npx convex dashboard           # open dashboard
npm run typecheck              # tsc --noEmit
npm run lint                   # eslint with @convex-dev/eslint-plugin

Do not run npx convex deploy, git commit, git push, or any publish command unless the current message asks for it.

Layout

convex/
  _generated/     generated, never edit, commit to git
  schema.ts       tables, validators, indexes
  http.ts         http router (exact name required)
  crons.ts        cron jobs
  convex.config.ts components registered with app.use
  <feature>.ts    functions, referenced as api.<feature>.<name>
src/              frontend
prds/             one PRD per non trivial change, plus lessons.md
files.md          what each file is for
changelog.md      Keep a Changelog, dates from git log
task.md           To Do / In Progress / Completed

Rules that hold everywhere

  1. Every function uses the object form with args and returns validators. returns: v.null() when nothing comes back.
  2. withIndex over filter. Index names list their fields: by_user_and_status.
  3. Mutations are idempotent. Early return when the doc is already in the target state. Patch without reading first when possible.
  4. Schedule internal.* functions only. Never api.*.
  5. No Date.now() inside a query. Pass time as an argument.
  6. "use node" only in action files that need Node APIs. No queries or mutations in those files.
  7. Throw ConvexError for errors the client should see.
  8. Keep query / mutation / action wrappers thin. Logic lives in plain functions.

Workflow

  • Non trivial work starts with a PRD in prds/. Load the project-workflow skill.
  • After a change lands, sync task.md, changelog.md, files.md. Load the project-docs skill.
  • Before any git command that could discard work, load the git-safety skill.
  • The request sets the scope. Extra ideas go in the summary, not the diff. Load avoid-feature-creep if unsure.

Style

  • No emojis. No em dashes.
  • Site design system for modals, alerts, confirmations. Never window.confirm or alert.
  • No placeholder text or images. Everything renders real data from Convex.
  • Short comments that say what a block is for.
  • Type safe. No any.

Project notes

[Business rules, naming conventions, architecture decisions, things that bit you before.]

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.