Groundwork AGENTS.md

A set of operating rules for Groundwork, a project-management system for taking software from an initial idea to maintained code. It defines how agents check project state, choose work, and record handoffs.

In plain words
What is it for?
Use it at the start of a Groundwork session to read the current state, load the right task guidance, work on one task, update the state file, and propose the next step.
Why use it?
It keeps work aligned with the project’s documented state and prevents agents from starting tasks or changing files without following the project’s decision process.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/tradebaas/groundwork/agents-md
Clone the repo
git clone --depth 1 https://github.com/Tradebaas/Groundwork

Made for: Codex, OpenCode.

Per session 2,067 This file is loaded in full into every session.
When invoked 2,067 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02067 $0.02067
Opus 5 $0.01033 $0.01033
Sonnet 5 $0.00413 $0.00413
Haiku 4.5 $0.00207 $0.00207

Measured 2d ago against content hash 5e909c486db0, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Groundwork AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 126 lines

How it starts

The opening of the file, as written. The whole thing — 126 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Groundwork: the operating system for this project

Groundwork tells any AI agent (in any IDE, on any model) how to take this project from first idea to delivered, maintained software at enterprise quality. This file is always loaded and is the single source of rules. Everything else loads on demand via the routing table below.

New project (docs/state/STATE.md still says NOT STARTED)? Load the skill begin and follow it.

Session protocol

  1. Read the handoff block at the top of docs/state/STATE.md before anything else. Do not re-derive project state from the codebase. That is what the file is for. (Maintainers of Groundwork itself: a gitignored docs/state/STATE.local.md, when present, takes STATE.md's place throughout this protocol.)
  2. Work one task at a time. When you finish, propose exactly one best next step, no menus.
  3. Before ending a session or after completing significant work: update docs/state/STATE.md. One fact, one place: update only the file that owns the fact.
  4. End every message with ⚓ to confirm these rules are loaded.

Decision ladder: run before writing anything

Stop at the first rung that holds:

  1. Does this need to exist? Not requested and not load-bearing → don't build it.
  2. Does it already exist in this repo? Reuse it. Never write a second version.
  3. Does the platform, stdlib, or an installed dependency do it? Use that.
  4. Only then: build the minimum that works, to the standards in docs/standards/.

Understanding comes before the ladder. A small diff you don't understand is not efficiency. Read enough to know the root cause, then fix the cause once, not the symptom everywhere.

Hard rules

  • Scope. All work must trace to docs/product/BRIEF.md or an explicit request. Out-of-scope findings and ideas go to docs/state/INTAKE.md: record them, don't build them.
  • Done is done. Stable, tested, in scope = finished. No gold-plating, no unrequested refactors, no "while I'm here". There is always something to improve; that is not a reason to.
  • Never bypass a gate. No --no-verify, no skipping hooks, no commenting out or weakening a check to make it pass. A red gate is information. If a gate is wrong, fix the gate in the open.
  • Security floor (never simplify away): input validation at trust boundaries, authorization checks, error handling that prevents data loss and never swallows a failure silently, secrets out of code and logs, accessibility.
  • Honesty. Report failures as failures, with output. Never claim something works that you did not verify. No reassuring the user against the evidence.
  • Verify before "done". Exercise the change end-to-end, not just the type checker. What you cannot verify, you flag. Details: skill verify.
  • Language. All governance text, code, comments, and commits in English. Write plainly: no em dashes, en dashes, curly quotes or ellipsis characters, and none of the AI-boilerplate phrasing banned in docs/design/VOICE.md. This holds for every file in this repo and every product built on Groundwork; checks/check.mjs (prose-style) enforces the mechanical part. Product-facing language is set per project in docs/design/VOICE.md.

Read the full file on GitHub · 126 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 126 lines · 2,067 tokens per session scan A 5e909c486db0

Subscribe to this mod's changes

Groundwork AGENTS.md is an instructions file published in the GitHub repository Tradebaas/Groundwork (2 stars, last pushed 6d ago), licensed MIT. It adds 2,067 tokens to every session, about $0.0103 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

node-typescript-boilerplate AGENTS.md

Instructions for jsynowiec/node-typescript-boilerplate, covering agents.md, ground rules (always), typescript, node.js and testing (vitest).

jsynowiec/node-typescript-boilerplate · 543 tokens

attractor-guided-engineering-template AGENTS.md

Instructions for entropy-cloud/attractor-guided-engineering-template, covering agents.md, project intent, dual-audience repo, in-tree tool and task routing.

entropy-cloud/attractor-guided-engineering-template · 2,830 tokens

spec-driven-development-template AGENTS.md

Instructions for juanklagos/spec-driven-development-template, covering mandatory reading order / orden obligatorio de lectura, mandatory workflow / flujo obligatorio, required reference / referencia obligatoria, final requirement / requisito final and uso explícito del repositorio base.

juanklagos/spec-driven-development-template · 2,681 tokens

claude-code-starter-kit CLAUDE.md

Instructions for muratsilahtaroglu/claude-code-starter-kit, covering claude.md — project constitution (template), session protocol (rules.md §9), what we're building, architecture (summary) and key decisions (adrs in docs/adr/).

muratsilahtaroglu/claude-code-starter-kit · 1,006 tokens

spec-driven-development-template CLAUDE.md

Instructions for juanklagos/spec-driven-development-template, a project described as: Operational SDD framework with AI guidance, GitHub Spec Kit workflows, and MCP support.

juanklagos/spec-driven-development-template · 627 tokens

spec-driven-development-template copilot-instructions.md

Instructions for juanklagos/spec-driven-development-template, a project described as: Operational SDD framework with AI guidance, GitHub Spec Kit workflows, and MCP support.

juanklagos/spec-driven-development-template · 493 tokens