Overview
Conventions are team rules with enforcement tiers:| Tier | Behavior |
|---|---|
must | Hard gate on PreToolUse — edits to files matching affected_files are blocked until the convention is superseded or marked stale. |
should | Surfaced as advisory context in sync. |
may | Recorded for awareness; no enforcement. |
affected_files narrow — broad must-tier conventions create false blocks.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Short convention title |
rationale | string | No | Why the team adopted it |
tier | string | No | must, should, or may (default should) |
affected_files | string[] | No | File paths the convention applies to |
affected_areas | string[] | No | Logical areas (e.g. auth, billing) |
session_id | string | No | Your session id |