---
Agent-Readme: 0.1
Name: <your project name>
Updated: 2026-01-01
---

# AGENT-README

## Purpose
<!-- One or two sentences: what this project is, and what "done" looks like. -->

## Setup & commands
- Install:
- Build:
- Test:
- Lint:
- Run:

## Guardrails
- Never modify:
- Never commit:
- Stop and ask before:
<!-- Lead with repo-specific rules (e.g. "never edit schema.generated.ts").
     Optional operating boundaries (still advisory):
     Filesystem: writable paths vs off-limits.
     Network: allowed or not, and which hosts.
     Commands: documented targets only, or open shell. -->

## Conventions
<!-- Language + version, formatting rules, structure, patterns to follow or avoid.
     Keep it short. Consider splitting non-negotiable facts from negotiable preferences: -->
<!-- Facts (non-negotiable): -->
<!-- Preferences (negotiable): -->

## Current state
<!-- Optional. Active refactors, known-failing areas, and what to leave alone. -->

## Surprises
<!-- Optional. Things a newcomer would not expect: intentional duplication,
     a table with no foreign keys by design, code that must not be renamed. -->

## Architecture
<!-- A short map of the codebase, links to deeper docs, and any MCP servers
     or context endpoints the agent should use. -->

## Contacts
- Owner:
- Issues: