Machine-readable reference

Workspai contract catalog

98 synced contracts define the stable boundaries between the CLI, workspace evidence, CI, IDEs, agents, and future adapters. Every contract below has a permanent educational reference page.

Agent grounding

1 versioned contract

Capability contract

Agent Customization Pack V1

Defines the versioned agent customization pack v1 boundary used by Workspai and its consumers.

workspai-agent-customization-pack-capabilities.v1

Command capabilities

2 versioned contracts

JSON Schema

Workspai Command Capabilities

Defines the versioned command capabilities v1 boundary used by Workspai and its consumers.

rapidkit-command-capabilities-v1
Capability contract

Runtime Command Surface V1

Defines the versioned runtime command surface v1 boundary used by Workspai and its consumers.

rapidkit-runtime-command-surface-v1

Compatibility

4 versioned contracts

JSON Schema

Workspai Compatibility Matrix

Defines the versioned compatibility matrix v1 boundary used by Workspai and its consumers.

rapidkit.compatibility-matrix.v1
Capability contract

Extension Cli Compatibility V1

Defines the versioned extension cli compatibility v1 boundary used by Workspai and its consumers.

rapidkit-extension-cli-compatibility.v1
Capability contract

Module Layout V1

Defines the versioned module layout v1 boundary used by Workspai and its consumers.

rapidkit.module-layout.v1
Capability contract

Module Support V1

Defines the versioned module support v1 boundary used by Workspai and its consumers.

rapidkit-module-support-v1

Diagnostics and remediation

7 versioned contracts

JSON Schema

Workspai Artifact Remediation Plan

Defines the versioned artifact remediation plan v1 boundary used by Workspai and its consumers.

artifact-remediation-plan-v1
JSON Schema

Workspai Doctor Project Evidence

Defines the versioned doctor project evidence v1 boundary used by Workspai and its consumers.

doctor-project-evidence-v1
JSON Schema

Workspai Doctor Project Scan

Defines the versioned doctor project scan v2 boundary used by Workspai and its consumers.

doctor-project-scan-v2
JSON Schema

Workspai Doctor Remediation Plan v2 Legacy Path Alias

Deprecated compatibility path. New consumers must resolve contracts/doctor-remediation-plan.v2.json.

doctor-remediation-plan-v2
JSON Schema

Workspai Doctor Remediation Plan v2

Canonical v2 contract. The referenced v1 path is retained as a deprecated compatibility alias.

alias -> doctor-remediation-plan.v1.json
JSON Schema

Workspai Doctor Workspace Cache

Defines the versioned doctor workspace cache v2 boundary used by Workspai and its consumers.

doctor-workspace-cache-v2
JSON Schema

Workspai Doctor Workspace Evidence

Defines the versioned doctor workspace evidence v1 boundary used by Workspai and its consumers.

doctor-workspace-evidence-v1

Evidence and release gates

4 versioned contracts

JSON Schema

Workspai Analyze Last Run Evidence

Defines the versioned analyze last run v1 boundary used by Workspai and its consumers.

rapidkit-analyze-v1
JSON Schema

Workspai Autopilot Release Evidence

Defines the versioned autopilot release v1 boundary used by Workspai and its consumers.

autopilot-release-v1
JSON Schema

Workspai Governance Pipeline Last Run

Defines the versioned pipeline last run v1 boundary used by Workspai and its consumers.

rapidkit-pipeline-v1
JSON Schema

Workspai Release Readiness Evidence

Defines the versioned release readiness v1 boundary used by Workspai and its consumers.

release-readiness-v1 | v1

Planning and generation

4 versioned contracts

JSON Schema

Workspai Infrastructure Plan

Defines the versioned infra plan v1 boundary used by Workspai and its consumers.

rapidkit.infra-plan.v1
Capability contract

Infra Stack V1

Canonical workspace infrastructure service catalog and module/env resolution rules.

rapidkit.infra-stack.v1
JSON Schema

Workspai Private Product Manifest

Defines the versioned private product manifest v1 boundary used by Workspai and its consumers.

rapidkit.private-product-manifest.v1
JSON Schema

Workspai Product Factory Plan

Defines the versioned product factory plan v1 boundary used by Workspai and its consumers.

rapidkit.product-factory-plan.v1

Platform contracts

13 versioned contracts

JSON Schema

Workspai Bootstrap Compliance Evidence

Defines the versioned bootstrap compliance v1 boundary used by Workspai and its consumers.

bootstrap-compliance.v1
JSON Schema

Workspai CLI Log Event

NDJSON stream events emitted on stderr when RAPIDKIT_LOG_FORMAT=json or --log-format json

cli-log-event-v1
JSON Schema

Workspai CLI Operation Result

Defines the versioned cli operation result v1 boundary used by Workspai and its consumers.

workspai-cli-operation-result-v1
Capability contract

Create Planner Capabilities V1

Defines the versioned create planner capabilities v1 boundary used by Workspai and its consumers.

rapidkit-create-planner-capabilities-v1
JSON Schema

Workspai Ingestion Plan v1

Defines the versioned ingestion plan v1 boundary used by Workspai and its consumers.

workspai.ingestion-plan.v1
JSON Schema

Workspai Ingestion Result v1

Defines the versioned ingestion result v1 boundary used by Workspai and its consumers.

workspai.ingestion-result.v1
JSON Schema

Workspai Mirror Operation Evidence

Defines the versioned mirror ops v1 boundary used by Workspai and its consumers.

mirror-ops.v1
Capability contract

Project Entry Capability V1

Defines the versioned project entry capability v1 boundary used by Workspai and its consumers.

workspai-project-entry-capability-v1
JSON Schema

Workspai Project Test Coverage Evidence

Defines the versioned project test coverage v1 boundary used by Workspai and its consumers.

workspai.project-test-coverage.v1
Capability contract

Published Contract Catalog V1

Defines the versioned published contract catalog v1 boundary used by Workspai and its consumers.

workspai-published-contract-catalog-v1
Capability contract

Studio Card Repair Capabilities V1

Defines the versioned studio card repair capabilities v1 boundary used by Workspai and its consumers.

workspai.studio-card-repair-capabilities.v1
JSON Schema

Workspai Transparency Evidence

Defines the versioned transparency evidence v1 boundary used by Workspai and its consumers.

transparency-evidence.v1
JSON Schema

Workspai Version Contract

Defines the versioned version v1 boundary used by Workspai and its consumers.

rapidkit-version-v1

Recovery and archival

8 versioned contracts

Snapshot contract

Backend Import Stack Parity Snapshot

Defines the versioned backend import stack parity snapshot boundary used by Workspai and its consumers.

backend-import-stack-parity-v1
Snapshot contract

Cli Runtime Command Inventory V1 Snapshot

Defines the versioned cli runtime command inventory v1 snapshot boundary used by Workspai and its consumers.

workspai-cli-runtime-command-inventory-v1
JSON Schema

Workspai Project Archive Manifest

Defines the versioned project archive v1 boundary used by Workspai and its consumers.

rapidkit-project-archive-v1
Capability contract

Workspace Archive Capabilities V1

Defines the versioned workspace archive capabilities v1 boundary used by Workspai and its consumers.

workspai-workspace-archive-capabilities-v1
JSON Schema

Workspai Workspace Archive Manifest v1

Defines the versioned workspace archive manifest v1 boundary used by Workspai and its consumers.

workspai-workspace-archive-manifest-v1
JSON Schema

Workspai Workspace Archive Operation Result v1

Defines the versioned workspace archive operation result v1 boundary used by Workspai and its consumers.

workspai-workspace-archive-operation-result-v1
JSON Schema

Workspai Workspace Snapshot v1

Defines the versioned workspace snapshot v1 boundary used by Workspai and its consumers.

rapidkit-workspace-snapshot-v1
JSON Schema

Workspai Workspace Snapshot v2

Defines the versioned workspace snapshot v2 boundary used by Workspai and its consumers.

rapidkit-workspace-snapshot-v2

Workspace Intelligence

42 versioned contracts

JSON Schema

Workspai Agent Action Outcome

Defines the versioned agent action outcome v1 boundary used by Workspai and its consumers.

agent-action-outcome.v1
JSON Schema

Workspai Agent Customization Pack Report

Defines the versioned agent customization pack report v1 boundary used by Workspai and its consumers.

rapidkit-agent-customization-pack.v1
JSON Schema

Workspai Agent Hooks

Defines the versioned agent hooks v1 boundary used by Workspai and its consumers.

workspai-agent-hooks.v1
JSON Schema

Workspai Agent Reports Index

Defines the versioned agent reports index v1 boundary used by Workspai and its consumers.

rapidkit-agent-reports-index.v1
JSON Schema

Workspai Blocker Resolution Hint

Defines the versioned blocker resolution v1 boundary used by Workspai and its consumers.

rapidkit-blocker-resolution-v1
JSON Schema

Workspai Doctor Capability Matrix

Defines the versioned doctor capabilities v1 boundary used by Workspai and its consumers.

workspai.doctor-capabilities.v1
JSON Schema

Workspai Doctor Dependency Repair Transaction v1

The portable closure contract for dependency security changes and runtime dependency materialization.

workspai.doctor-dependency-repair-transaction.v1
JSON Schema

Workspai Universal Doctor Diagnosis

Defines the versioned doctor diagnosis v1 boundary used by Workspai and its consumers.

workspai.doctor-diagnosis.v1
JSON Schema

Workspai Doctor Fix Execution Result

Defines the versioned doctor fix result v1 boundary used by Workspai and its consumers.

rapidkit-doctor-fix-result-v1
JSON Schema

Workspai Doctor Graph Diagnosis

Defines the versioned doctor graph diagnosis v1 boundary used by Workspai and its consumers.

doctor-graph-diagnosis.v1
JSON Schema

Workspai Doctor Receipt

Defines the versioned doctor receipt v1 boundary used by Workspai and its consumers.

workspai.doctor-receipt.v1
JSON Schema

Workspai Doctor JSON Summary

Defines the versioned doctor summary v1 boundary used by Workspai and its consumers.

workspai.doctor-summary.v1
JSON Schema

Workspai Doctor Validation Report

Defines the versioned doctor validation v1 boundary used by Workspai and its consumers.

workspai.doctor-validation.v1
JSON Schema

Workspai Fact Freshness Contract

Defines the versioned fact freshness v1 boundary used by Workspai and its consumers.

rapidkit-fact-freshness-v1
JSON Schema

Workspai MCP Design

Defines the versioned mcp design v1 boundary used by Workspai and its consumers.

workspai-mcp-design.v1
JSON Schema

Workspai Model and Agent Usage Event

A privacy-bounded usage observation. Prompt and response bodies are deliberately excluded; consumers may provide hashes instead.

model-usage-event.v1
JSON Schema

Workspai Project Context for Agents

Portable, bounded project lens derived from the canonical Workspace Model and evidence-backed Knowledge Graph.

project-context-agent.v1
JSON Schema

Workspai Studio Blocker Handoff

Defines the versioned studio blocker handoff v1 boundary used by Workspai and its consumers.

rapidkit-studio-blocker-handoff-v1
JSON Schema

Workspai Verified Goal Status

The durable progress and evidence-derived terminal state of a Workspai verified goal.

workspai.verified-goal-status.v1
JSON Schema

Workspai Verified Goal

A durable, deterministic success contract for an agent-executed engineering goal.

workspai.verified-goal.v1
JSON Schema

Workspai Workspace Agent Context

Defines the versioned workspace context v1 boundary used by Workspai and its consumers.

workspace-context.v1
JSON Schema

Workspai Workspace Contract Verify Evidence

Defines the versioned workspace contract verify v1 boundary used by Workspai and its consumers.

workspace-contract-verify.v1
JSON Schema

Workspai Workspace Dependency Graph

First-class, versioned dependency graph of inter-project relationships consumed by impact, verify, run --blast-radius, and risk weighting.

workspace-dependency-graph.v1
JSON Schema

Workspai Workspace Explain Report

Defines the versioned workspace explain v1 boundary used by Workspai and its consumers.

workspace-explain.v1
JSON Schema

Workspai Workspace Graph Stream

Transport-neutral, revision-safe events for hydrating and incrementally updating a Workspace Knowledge Graph consumer.

workspace-graph-stream.v1
JSON Schema

Workspai Graph Retrieval Token-Efficiency Report

A reproducible character-based estimate comparing readable proof-source text with one bounded graph retrieval payload. It is not an answer-quality or billing claim.

workspace-graph-token-efficiency.v1
JSON Schema

Workspai Workspace Impact

Defines the versioned workspace impact v1 boundary used by Workspai and its consumers.

workspace-impact.v1
JSON Schema

Workspai Workspace Intelligence Evaluation Comparison

A task-aligned comparison between two provenance-aware Workspace Intelligence evaluation runs.

workspace-intelligence-evaluation-comparison.v1
JSON Schema

Workspai Workspace Intelligence Evaluation

A live or finalized, provenance-aware measurement of model usage, agent activity, and verified task outcome.

workspace-intelligence-evaluation.v1
JSON Schema

Workspai Workspace Intelligence History

Defines the versioned workspace intelligence history v1 boundary used by Workspai and its consumers.

workspace-intelligence-history.v1
JSON Schema

Workspai Workspace Intelligence Run

Defines the versioned workspace intelligence run v1 boundary used by Workspai and its consumers.

workspace-intelligence-run.v1
JSON Schema

Workspai Workspace Knowledge Graph Change Overlay

Portable graph-to-graph entity and relation changes with bounded impact and proof artifact projection.

workspace-knowledge-graph-change-overlay.v1
JSON Schema

Workspai Evidence-backed Workspace Knowledge Graph

Portable, provider-neutral workspace entities, relations and proof paths derived from and structurally bound to the canonical Workspace Model. The embedded project topology is the model's graph projection.

workspace-knowledge-graph.v1
JSON Schema

Workspai Bounded Knowledge Graph Search

A deterministic, bounded, proof-carrying retrieval projection intended for agents, MCP clients, IDEs, and CI consumers.

workspace-knowledge-search.v1
JSON Schema

Workspai Workspace Model Diff

Defines the versioned workspace model diff v1 boundary used by Workspai and its consumers.

workspace-model-diff.v1
JSON Schema

Workspai Workspace Model Snapshot

Defines the versioned workspace model snapshot v1 boundary used by Workspai and its consumers.

workspace-model-snapshot.v1
JSON Schema

Workspai Workspace Intelligence Model

Defines the versioned workspace model v1 boundary used by Workspai and its consumers.

workspace-model.v1
JSON Schema

Workspai Workspace Operational Skill

Defines the versioned workspace operational skill v1 boundary used by Workspai and its consumers.

workspace-operational-skill.v1
JSON Schema

Workspai Workspace Repair Proposal v1

A bounded, hash-pinned source change proposed by an IDE model for execution by the CLI Repair Engine.

workspai.workspace-repair-proposal.v1
JSON Schema

Workspai Workspace Repair Transaction v1

Durable CLI-owned state for one governed workspace repair from plan through verification or rollback.

workspai.workspace-repair-transaction.v1
JSON Schema

Workspai Workspace Skills Index

Defines the versioned workspace skills index v1 boundary used by Workspai and its consumers.

workspace-skills-index.v1
JSON Schema

Workspai Workspace Verify Last Run

Defines the versioned workspace verify v1 boundary used by Workspai and its consumers.

workspace-verify.v1

Workspace operations

13 versioned contracts

JSON Schema

Workspai Project Workspace Link

Machine-local, gitignored binding from a Workspai project to its canonical workspace. Absolute paths are permitted only in this local contract.

project-workspace-link.v1
JSON Schema

Workspai Project Workspace Resolution

Machine-readable result of resolving or repairing a project's canonical Workspai workspace binding.

project-workspace-resolution.v1
JSON Schema

Workspai Workspace Contract

Defines the versioned workspace contract v1 boundary used by Workspai and its consumers.

https://workspai.dev/schemas/workspace-contract.v1.json
Capability contract

Workspace Intelligence Architecture V1

Defines the versioned workspace intelligence architecture v1 boundary used by Workspai and its consumers.

workspai-workspace-intelligence-architecture-v1
Capability contract

Workspace Intelligence Chain V1

Defines the versioned workspace intelligence chain v1 boundary used by Workspai and its consumers.

workspai-workspace-intelligence-chain-v1
JSON Schema

Workspai Workspace List

Defines the versioned workspace list v1 boundary used by Workspai and its consumers.

rapidkit-workspace-list-v1
JSON Schema

Workspai Workspace Model Cache

Defines the versioned workspace model cache v1 boundary used by Workspai and its consumers.

workspace-model-cache.v1
JSON Schema

Workspai Workspace Registry Summary

Defines the versioned workspace registry v1 boundary used by Workspai and its consumers.

workspace-registry.v1
Capability contract

Workspace Repair Capabilities V1

Defines the versioned workspace repair capabilities v1 boundary used by Workspai and its consumers.

workspai.workspace-repair-capabilities.v1
JSON Schema

Workspai Workspace Run Evidence

Defines the versioned workspace run last v1 boundary used by Workspai and its consumers.

workspace-run-v1
JSON Schema

Workspai Workspace Share Bundle

Defines the versioned workspace share bundle v1 boundary used by Workspai and its consumers.

https://workspai.dev/schemas/workspace-share-bundle.v1.json
JSON Schema

Workspai Workspace Sync Evidence

Defines the versioned workspace sync v1 boundary used by Workspai and its consumers.

rapidkit-workspace-sync-v1
JSON Schema

Workspai Workspace Watch Event

Defines the versioned workspace watch event v1 boundary used by Workspai and its consumers.

workspace-watch-event.v1