Agent instructionsScan: pass

AGENTS.md template with commands table and definition of done

Fill-in-the-blanks AGENTS.md: purpose, stack, commands table, definition of done, gotchas, and a pointer to shared rules and skills.

License: CC0-1.0 · By waxmark · v1 · 2026-11-02

Share on X

Add a trust badge to your README

[![Waxmark](https://waxmark.app/api/badge/agents-md-template-commands-and-done)](https://waxmark.app/items/agents-md-template-commands-and-done/scan)
Report
# Agent Instructions — {Project Name}

Copy this file to a repo's root as `AGENTS.md` and fill every section. Delete lines that do not apply. Agents read this before every task, so keep it factual and short: facts the agent cannot infer from the code are worth more than principles.

## Project

- **Purpose:** {one line: what it does and for whom}
- **Stack:** {framework versions, language, database, chain or runtime}
- **Layout:** {where the app, contracts, scripts, and tests live if not obvious}
- **Package manager:** {npm | pnpm | bun | pip | cargo | forge}

## Commands

Run these from `{directory}` unless noted. Agents run the check commands before reporting work as done.

| Task | Command |
|------|---------|
| Install | `{pnpm install}` |
| Dev server | `{pnpm dev}` → http://localhost:{3000} |
| Test | `{pnpm test}` |
| Typecheck | `{pnpm typecheck}` |
| Lint | `{pnpm lint}` |
| Build | `{pnpm build}` |

## Definition of done

- Tests, typecheck, and lint pass with the commands above.
- {UI repos: `visual-qa-testing` run on the changed page, console clean.}
- `ConnectionGuide.txt` updated if any port, route, or integration changed.
- {Anything else that must be true before the work is finished.}

## Shared config

- **Rules:** `.cursor/rules/` → [cursor-rules](https://github.com/PenneconDavid/cursor-rules)
- **Skills:** `.agents/skills/` → [cursor-skills](https://github.com/PenneconDavid/cursor-skills)
- **Tier 2 UI skills:** {apply | do not apply (no web dev server)}

## Gotchas

- {Things that have burned an agent before: a path that moved, a flag that must be set, a test that needs a service running.}
- {Env vars required for local dev, by name. Never values.}
- {Anything that looks wrong but is intentional.}

## Key entry points

- {`src/app/api/` — API routes}
- {`contracts/Main.sol` — primary contract}

## Do not

- {Files or areas the agent must not modify without asking.}
- {Operations that need approval beyond the shared guardrails, for example flashing firmware or touching a deployed contract.}
AGENTS.md template with commands table and definition of done · Waxmark