om-create-agents-md

name: om-create-agents-md description: Create or rewrite AGENTS.md files for Open Mercato packages and modules. Use this skill when adding a new package, creating a new module, or when an existing AGENTS.md needs to be created or refactored. Ensures prescriptive tone, the Always/Ask First/Never/Validation Commands boundary structure, MUST-style rules, checklists, and consistent structure across all agent guidelines.

Create prescriptive, action-oriented AGENTS.md files that tell agents what to DO, what to ASK ABOUT, what NEVER to do, and how to VALIDATE their work. Never write descriptive documentation — write instructions.

Authoritative source for the boundary convention: root AGENTS.md → ## Boundary Labels for Agent Rules. This skill follows that convention.

Core Philosophy

AGENTS.md files are not documentation. They are instruction sets for coding agents. Every sentence should either:

• Tell the agent what to do ("Use X when...")
• Constrain the agent's behavior ("MUST NOT...")
• Give a step-by-step procedure ("1. Create... 2. Add... 3. Run...")

Boundary Section Convention

Every AGENTS.md MUST use these four top-level boundary sections, in this order, with these exact headings:

These four headings are required. Additional sections (decision tables, checklists, structure tree, cross-references, etc.) live alongside them, never instead of them.

File Structure Template

Every AGENTS.md follows this structure. Adapt sections based on file size (small: 40-80 lines, medium: 80-150 lines, large: 150+ lines).

The template below is wrapped in a 4-backtick fence so the nested 3-backtick Validation Commands example renders correctly on GitHub.

# {Name} — Agent Guidelines

{One-line imperative directive: "Use X for Y." or "Use the Z module for A, B, and C."}

## {Optional decision/selection table — e.g. "Strategy Selection", "When to Use"}

{Table with "When to use" / "Configuration" columns}

## Always

1. **MUST ...** — {consequence or rationale}
2. **MUST NOT ...** — {what to do instead}
3. **MUST ...** — {consequence or rationale}

## Ask First

- Ask before {decision that needs maintainer input — scope, contract surface, dependency, infra}.
- Ask before {second decision class — typically destructive or cross-module}.

## Never

- Never {prohibited action — bypassing tenant scoping, skipping hooks, raw fetch, etc.}.
- Never {second prohibition}.

## Validation Commands

```bash
yarn workspace @open-mercato/{package} test
yarn workspace @open-mercato/{package} build
```

## {Primary Task Section — "When You Need X" or "Adding a New Y"}

{Numbered checklist or decision table}

## {Secondary Sections}

{Tables with "When to use" / "When to modify" columns}

## Structure

{Directory tree — keep brief}

## {Cross-References} (if applicable)

- **For X**: `path/to/AGENTS.md` → Section

Prescriptive Tone Rules

NEVER start a section with

• "The module provides..."
• "This package is..."
• "This document describes..."
• "X is a Y that..."

ALWAYS start sections with

• Imperative verbs: "Use", "Add", "Create", "Configure", "Declare", "Follow", "Resolve"
• Conditional directives: "When you need X, do Y"
• Constraints: "MUST", "MUST NOT"

Transform Patterns

Boundary Section Requirements

The Always, Ask First, Never, and Validation Commands headings are mandatory in every AGENTS.md. The Always section is where MUST/MUST NOT rules live, and its minimum item count scales with file size:

If a real prohibition only fits one of the boundaries, prefer the most restrictive: Never > Ask First > Always.

Writing Effective Always Rules

Each Always rule follows this pattern: **MUST [verb]** — [rationale or consequence]

Good examples:

• **MUST resolve via DI** — always use container.resolve('cacheService'), never instantiate directly
• **MUST NOT reimplement pricing logic** — use selectBestPrice and the resolver pipeline
• **MUST export metadata** with { queue, id?, concurrency? } from every worker file
• **MUST follow document flow**: Quote → Order → Invoice — no skipping steps

Bad examples:

• **MUST** follow best practices (too vague)
• **MUST** be careful with... (not actionable)
• **MUST** use the correct approach (says nothing)

Writing Effective Ask First Items

Phrase as Ask before {scope-changing action}. Each item names a concrete decision that a maintainer (human) should approve.

Good examples:

• Ask before adding a new cache backend, changing default strategy selection, or caching data whose sensitivity is unclear.
• Ask before changing queue strategy defaults, retry semantics, or worker concurrency limits.
• Ask before applying database migrations locally with yarn db:migrate.

Bad examples:

• Ask if unsure (uselessly generic — every rule could say that)
• Ask before doing anything dangerous (not actionable)

Writing Effective Never Items

Phrase as Never {prohibited action}. Do NOT prefix with "MUST NOT" — the section heading already supplies that force.

Good examples:

• Never expose cross-tenant data or skip tenant/organization scoping.
• Never use raw fetch in backend pages — always go through apiCall.
• Never edit generated files by hand.

Bad examples:

• Avoid X (too soft for Never)
• Try not to Y (not a rule)

Writing Effective Validation Commands

List the smallest set of real commands an agent can copy-paste to prove the relevant path. Prefer package-scoped commands over repo-wide ones for module/package AGENTS.md files.

Good examples:

yarn workspace @open-mercato/cache test
yarn workspace @open-mercato/cache build

yarn generate
yarn typecheck
yarn workspace @open-mercato/core test --testPathPattern=customers

Bad examples:

• Run the tests (not a command)
• yarn test:everything --all-the-things (invented or impractical)

Table Column Conventions

NEVER use these column headers

• "Description"
• "Purpose" (as standalone — use "Purpose / MUST rules" instead)
• "Details"

ALWAYS use these column headers

Checklist Sections

Include numbered checklists for common tasks. Pattern: "Adding a New X" or "Checklist: Do Y"

## Adding a New Worker

1. Create worker file in `src/modules/<module>/workers/<worker-name>.ts`
2. Export `metadata` with `{ queue: '<queue-name>', id: '<worker-id>', concurrency: <n> }`
3. Export default async handler function
4. Ensure handler is idempotent — check state before mutating
5. Run `yarn generate` to register the worker
6. Test with `QUEUE_STRATEGY=local` in development

Every checklist MUST:

• Use numbered steps (not bullets)
• Start each step with an imperative verb
• Include the yarn generate step when adding module files
• End with a testing/verification step

Data Model Sections

Convert entity lists to constraint-framed bullets:

## Data Model Constraints

- **Products** — core entities with media. MUST have at least a name
- **Categories** — hierarchical. MUST maintain parent-child integrity (no circular references)
- **Variants** — linked via `product_id`. MUST reference valid option schemas
- **Prices** — multi-tier with channel scoping. MUST use `selectBestPrice` for resolution

Pattern: **Entity** — brief description. MUST [constraint]

Cross-Reference Rules

When two AGENTS.md files cover related topics:

1. Pick one authoritative source for each topic — never duplicate full content
2. Use condensed quick-references in the non-authoritative file
3. Add a Cross-Reference section at the bottom linking to related guides
4. Keep the Task Router in root AGENTS.md accurate with descriptive task names

Example:

## Cross-Reference

- **Declaring events in a module**: `packages/core/AGENTS.md` → Events
- **Queue worker contract**: `packages/queue/AGENTS.md`

File Size Guidelines

Sizing Rules

• Keep small files focused — do not pad with unnecessary sections
• Large files: keep ALL technical content, only reframe tone
• Root AGENTS.md: MUST stay under 230 lines

Code Examples in AGENTS.md

• Include code examples only for contracts (worker metadata, event declaration, subscriber export)
• Keep examples minimal — 3-5 lines max for inline snippets
• For full API examples, cross-reference the relevant module or spec
• MUST NOT include implementation details — only show the interface/pattern

Verification Checklist

After writing an AGENTS.md, verify:

1. Boundary headings present: File contains exactly one of each ## Always, ## Ask First, ## Never, and ## Validation Commands, in that order. Confirm with grep -nE '^## (Always|Ask First|Never|Validation Commands)$' <file>.
2. Always audit: File has required number of MUST/MUST NOT rules in ## Always (3+ small, 5+ medium, 8+ large).
3. Ask First populated: At least one concrete "Ask before …" item that names a scope-changing decision.
4. Never populated: At least one "Never …" prohibition; phrased as a "Never" bullet, not "MUST NOT".
5. Validation Commands runnable: Commands are real and copy-pasteable; no placeholder or invented scripts.
6. Tone: Every section starts with imperative verb or "When you need..."
7. No descriptive openers: No section starts with "The module provides..." or similar.
8. Tables: All tables use "When to use" / "When to modify" columns, never "Description".
9. Checklists: Common tasks have numbered step-by-step procedures.
10. Data models: Entity lists are constraint-framed with MUST rules.
11. Cross-references: No duplicated content between files; clear pointers instead.
12. Structure section: Directory tree is present and brief.
13. Opening line: File starts with one-line imperative directive, not a description.

Anti-Patterns

1. Explaining how things work instead of telling agents what to do
2. Listing features instead of listing constraints
3. Duplicating content across multiple AGENTS.md files
4. Writing paragraphs where a checklist would be clearer
5. Adding changelog sections to small/medium files (only for large files with complex history)
6. Over-documenting internals — AGENTS.md guides usage, not implementation
7. Missing the "when" framing — every table/section should answer "when do I use this?"
8. Skipping a boundary section because "the file is small" — every AGENTS.md MUST carry all four (Always, Ask First, Never, Validation Commands). Tighten the content per file size; do not omit headings.
9. Reusing legacy headings like ## MUST Rules, ## Critical Rules, ## Key Rules, or MUST Rules/MANDATORY: as H2s. These predate the boundary convention and are not accepted.
10. Mixing forces — putting MUST NOT rules under Never, or Never … bullets under Always. Each section's heading carries the force; phrase items to match.

Reference Examples

Study these files as reference implementations — all updated to the boundary convention in PR #2082:

When Updating Root AGENTS.md Task Router

After creating a new AGENTS.md, update the Task Router table in root AGENTS.md:

1. Add a row with descriptive task keywords (not just the package name)
2. Include specific function names, patterns, and task verbs an agent would search for
3. Keep the root file under 230 lines

Migrating an Existing AGENTS.md to the Boundary Convention

When refactoring an older AGENTS.md that predates PR #2082:

1. Identify legacy headings — typically ## MUST Rules, ## Critical Rules, ## Key Rules, or mixed ## Always / Never blocks.
2. Hoist each existing rule into the correct boundary:
   • MUST/MUST NOT defaults → ## Always, preserving the **MUST [verb]** — [rationale] pattern.
   • Scope/contract decisions that need maintainer approval → ## Ask First, phrased as Ask before ….
   • Hard prohibitions and unsafe shortcuts → ## Never, phrased as Never ….
3. Add a ## Validation Commands block with the smallest set of real, package-scoped commands that prove the affected path.
4. Preserve any high-risk operational details (hard tool-call limits, AskUserQuestion confirmation boundaries, encryption defaults, etc.) — content reclassification is fine, content loss is not.
5. Verify with grep -nE '^## (Always|Ask First|Never|Validation Commands)$' <file> that all four headings exist.
6. Update any other docs that referenced the legacy section anchors (#must-rules, #critical-rules, etc.).