Workspace Intelligence / JSON Schema

Workspai Agent Reports Index

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

Schema version: rapidkit-agent-reports-index.v1
Contract path: contracts/workspace-intelligence/agent-reports-index.v1.json
Publication: embedded-type, json-schema
Defined fields: 21
Artifact bindings: 1

Why this contract exists

Architecture role

Projects workspace intelligence into stable grounding surfaces for agents and integrations.

Consumption boundary

• Workspai CLI
• AI agents
• IDEs and MCP clients

Related commands

Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.

workspai workspace agent-sync

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

Artifact path	Schema	Producer
.workspai/reports/INDEX.json	rapidkit-agent-reports-index.v1	workspai workspace agent-sync --write --json --preset enterprise

Field reference

Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.

Field path	Type	Required	Meaning	Constraints
blockers	array	Yes	Defines the blockers value at this contract boundary.	—
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
intelligenceChain	object	Yes	Defines the intelligencechain value at this contract boundary.	additionalProperties: false
intelligenceChain.contractPath	string	Yes	Defines the contractpath value at this contract boundary.	minLength: 1
intelligenceChain.currentStep	string	Yes	Defines the currentstep value at this contract boundary.	const: "agent-sync"
intelligenceChain.schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	minLength: 1
readOrder	array	Yes	Defines the readorder value at this contract boundary.	—
refreshCommand	string	Yes	Defines the refreshcommand value at this contract boundary.	minLength: 1
reports	array	Yes	Defines the reports value at this contract boundary.	—
reports[].commandId	string	No	Defines the commandid value at this contract boundary.	—
reports[].exists	boolean	Yes	Defines the exists value at this contract boundary.	—
reports[].exitCode	integer	No	Defines the exitcode value at this contract boundary.	—
reports[].generatedAt	string	No	Defines the generatedat value at this contract boundary.	format: date-time
reports[].label	string	Yes	Defines the label value at this contract boundary.	minLength: 1
reports[].path	string	Yes	Defines the path value at this contract boundary.	minLength: 1
reports[].required	boolean	Yes	Defines the required value at this contract boundary.	—
reports[].validationError	string	No	Defines the validationerror value at this contract boundary.	—
reports[].validity	enum	Yes	Defines the validity value at this contract boundary.	enum: valid, invalid, uncontracted, missing
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit-agent-reports-index.v1"
staleAfterHours	number	Yes	Defines the staleafterhours value at this contract boundary.	minimum: 0
workspaceRoot	string	Yes	Defines the workspaceroot value at this contract boundary.	minLength: 1

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://workspai.dev/schemas/agent-reports-index.v1.json",
  "title": "Workspai Agent Reports Index",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspaceRoot",
    "intelligenceChain",
    "readOrder",
    "blockers",
    "staleAfterHours",
    "reports",
    "refreshCommand"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit-agent-reports-index.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspaceRoot": {
      "type": "string",
      "minLength": 1
    },
    "intelligenceChain": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "contractPath",
        "currentStep"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "minLength": 1
        },
        "contractPath": {
          "type": "string",
          "minLength": 1
        },
        "currentStep": {
          "const": "agent-sync"
        }
      }
    },
    "readOrder": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "blockers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "staleAfterHours": {
      "type": "number",
      "minimum": 0
    },
    "reports": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "path",
          "label",
          "required",
          "exists",
          "validity"
        ],
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "required": {
            "type": "boolean"
          },
          "exists": {
            "type": "boolean"
          },
          "validity": {
            "enum": [
              "valid",
              "invalid",
              "uncontracted",
              "missing"
            ]
          },
          "validationError": {
            "type": "string"
          },
          "generatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "commandId": {
            "type": "string"
          },
          "exitCode": {
            "type": "integer"
          }
        }
      }
    },
    "refreshCommand": {
      "type": "string",
      "minLength": 1
    }
  }
}