Skip to main content

Overview

Conventions are team rules with enforcement tiers:
TierBehavior
mustHard gate on PreToolUse — edits to files matching affected_files are blocked until the convention is superseded or marked stale.
shouldSurfaced as advisory context in sync.
mayRecorded for awareness; no enforcement.
Keep affected_files narrow — broad must-tier conventions create false blocks.

Parameters

ParameterTypeRequiredDescription
titlestringYesShort convention title
rationalestringNoWhy the team adopted it
tierstringNomust, should, or may (default should)
affected_filesstring[]NoFile paths the convention applies to
affected_areasstring[]NoLogical areas (e.g. auth, billing)
session_idstringNoYour session id

Example

{
  "tool": "convention_propose",
  "arguments": {
    "title": "Use zod for all request body validation",
    "rationale": "Single source of truth for schemas; prevents the joi/yup/zod triad we ended up with last quarter.",
    "tier": "must",
    "affected_files": ["src/routes/**/*.ts"]
  }
}