Skip to content

Schemas

SNIPER uses YAML schemas to define the structure of runtime data files. These schemas validate checkpoints, gate results, and more.

Schema Files

All schemas live in packages/core/schemas/ and follow the JSON Schema 2020-12 specification in YAML format.

SchemaPurpose
checkpointPhase checkpoint tracking (protocol, phase, status, agents, commits)
gate-resultGate evaluation results (phase, checks, pass/fail, multi-model results)
live-statusActive protocol status (current phase, agents, tasks)
protocolProtocol definition (name, phases, agents, spawn strategy, gates)
retroRetrospective report (protocol, metrics, findings, signal analysis)
signalExternal signal record (type, source, timestamp, affected files, learning)
workspaceWorkspace configuration (shared conventions, anti-patterns, triggers)
workspace-lockFile-level advisory lock (file path, owner, acquired timestamp)
revert-planLogical revert instructions (target state, commits to revert)
knowledge-manifestDomain knowledge registry (sources, descriptions, token limits)
dependency-graphTask dependency tracking (tasks, dependencies, blocking relationships)

Usage

Schemas are used by:

  • Gate reviewer -- validates checkpoint and gate result files
  • Lead orchestrator -- writes checkpoints conforming to the schema
  • Retro analyst -- writes retro data
  • CLI protocol validate -- validates custom protocols against the protocol schema

Browse individual schema reference pages in the sidebar.