Workspace Intelligence / JSON Schema

Workspai Agent Customization Pack Report

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

Schema version: rapidkit-agent-customization-pack.v1
Contract path: contracts/workspace-intelligence/agent-customization-pack-report.v1.json
Publication: embedded-type, json-schema
Defined fields: 26
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/agent-customization-pack.json	rapidkit-agent-customization-pack.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
answerContract	array	Yes	Defines the answercontract value at this contract boundary.	—
capabilityMatrix	object	Yes	Defines the capabilitymatrix value at this contract boundary.	additionalProperties: true
drift	object	Yes	Defines the drift value at this contract boundary.	additionalProperties: false
drift.missingRequired	array	Yes	Defines the missingrequired value at this contract boundary.	—
drift.staleReports	array	Yes	Defines the stalereports value at this contract boundary.	—
drift.strictViolations	array	Yes	Defines the strictviolations value at this contract boundary.	—
experimental	object	Yes	Defines the experimental value at this contract boundary.	additionalProperties: false
experimental.hooksEnabled	boolean	Yes	Defines the hooksenabled value at this contract boundary.	—
experimental.mcpReady	boolean	Yes	Defines the mcpready 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
outputInventory	array	Yes	Defines the outputinventory value at this contract boundary.	—
outputInventory[].kind	enum	Yes	Defines the kind value at this contract boundary.	enum: report, grounding, instruction, prompt, skill, skill-resource, operational-skill, skills-index, explain-report, agent, rule, hook, mcp-design
outputInventory[].path	string	Yes	Defines the path value at this contract boundary.	minLength: 1
outputInventory[].required	boolean	Yes	Defines the required value at this contract boundary.	—
outputInventory[].status	enum	Yes	Defines the status value at this contract boundary.	enum: written, planned, skipped
outputInventory[].targets	array	Yes	Defines the targets value at this contract boundary.	—
preset	enum	Yes	Defines the preset value at this contract boundary.	enum: minimal, enterprise
refreshCommand	string	Yes	Defines the refreshcommand value at this contract boundary.	minLength: 1
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit-agent-customization-pack.v1"
sourceReports	array	Yes	Defines the sourcereports value at this contract boundary.	—
targets	array	Yes	Defines the targets value at this contract boundary.	—
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-customization-pack-report.v1.json",
  "title": "Workspai Agent Customization Pack Report",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspaceRoot",
    "preset",
    "targets",
    "sourceReports",
    "intelligenceChain",
    "outputInventory",
    "capabilityMatrix",
    "drift",
    "answerContract",
    "refreshCommand",
    "experimental"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit-agent-customization-pack.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspaceRoot": {
      "type": "string",
      "minLength": 1
    },
    "preset": {
      "enum": [
        "minimal",
        "enterprise"
      ]
    },
    "targets": {
      "type": "array",
      "items": {
        "enum": [
          "all",
          "vscode",
          "agents",
          "copilot",
          "cursor",
          "claude",
          "codex",
          "orca"
        ]
      }
    },
    "sourceReports": {
      "type": "array",
      "items": {
        "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"
        }
      }
    },
    "outputInventory": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "path",
          "kind",
          "targets",
          "required",
          "status"
        ],
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "kind": {
            "enum": [
              "report",
              "grounding",
              "instruction",
              "prompt",
              "skill",
              "skill-resource",
              "operational-skill",
              "skills-index",
              "explain-report",
              "agent",
              "rule",
              "hook",
              "mcp-design"
            ]
          },
          "targets": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "required": {
            "type": "boolean"
          },
          "status": {
            "enum": [
              "written",
              "planned",
              "skipped"
            ]
          }
        }
      }
    },
    "capabilityMatrix": {
      "type": "object",
      "additionalProperties": true
    },
    "drift": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "missingRequired",
        "staleReports",
        "strictViolations"
      ],
      "properties": {
        "missingRequired": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "staleReports": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "strictViolations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "answerContract": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "refreshCommand": {
      "type": "string",
      "minLength": 1
    },
    "experimental": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "hooksEnabled",
        "mcpReady"
      ],
      "properties": {
        "hooksEnabled": {
          "type": "boolean"
        },
        "mcpReady": {
          "type": "boolean"
        }
      }
    }
  }
}