Skip to content
Unverified: This page has not yet been anchored to automated code tests.

Contracts

ArtifactPurpose
codex-api.openapi.yamlHTTP surface for vox-codex-api / run_dashboard (guarded by vox ci check-codex-ssot).
cli/command-registry.yamlShipped CLI surface; validate with vox ci command-compliance from the repo root (canonical); shell delegates are optional.
communication/protocol-catalog.yamlCommunication protocol family inventory: delivery planes, owners, contract/doc paths, and coexistence decisions.
communication/context-envelope.schema.jsonCanonical context envelope contract for MCP, orchestrator, search, and Populi handoffs.
mcp/http-gateway.openapi.yamlOptional bounded HTTP/WebSocket surface exposed by vox-mcp (VOX_MCP_HTTP_*).
mcp/tool-registry.canonical.yamlMCP tool names + descriptions; compile-time via crates/vox-mcp-registry.
mcp/http-read-role-governance.yamlCanonical MCP HTTP read-role tool profile enforced by vox ci command-compliance.
orchestration/agent-harness.schema.jsonPortable contract-first harness specification for roles, stages, gates, durable state, and failure taxonomy.
orchestration/context-work-item.schema.jsonWork-item schema for context-management epics, capabilities, and tasks.
populi/control-plane.openapi.yamlPopuli mesh control-plane + A2A relay OpenAPI contract.
workflow/workflow-journal.v1.schema.jsonInterpreted workflow journal v1 JSON Schema contract (indexed as workflow-journal-v1-schema; validated via vox ci contracts-index).
rust/ecosystem-support.yamlRust crate-family support matrix (tier/boundary/value/debt) for bell-curve lanes.
index.yamlMachine-readable list of contract artifacts (vox ci contracts-index).

See Codex HTTP API reference. SSOT guard: vox ci check-codex-ssot (the canonical cross-platform guard — shell delegate scripts scripts/check_codex_ssot.* have been removed; use vox ci directly).

CI entrypoint: prefer vox ci … over ad-hoc scripts/*.sh where a vox ci subcommand exists — see runner contract and command compliance.