All contracts

Workspace Intelligence / JSON Schema

Workspai Agent Framework Change Plan v1

Defines the versioned agent framework change plan v1 boundary used by Workspai and its consumers.

Schema version
workspai.agent-framework-change-plan.v1
Contract path
contracts/workspace-intelligence/agent-framework-change-plan.v1.json
Publication
json-schema
Defined fields
22
Artifact bindings
0

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.

This is a supporting, capability, cache, compatibility, or consumer contract. It has no single direct producer command in the canonical Workspace Intelligence execution registry.

Produced artifacts

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

No canonical file artifact is registered for this contract. It may describe capabilities, embedded data, runtime exchange, or supporting state instead of a standalone report.

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 pathTypeRequiredMeaningConstraints
adapterIdstringYesDefines the adapterid value at this contract boundary.pattern: ^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$
adapterVersionstringYesDefines the adapterversion value at this contract boundary.minLength: 1
blockersarrayYesDefines the blockers value at this contract boundary.minItems: 0
changesarrayYesDefines the changes value at this contract boundary.—
changes[].kindenumYesDefines the kind value at this contract boundary.enum: create-file, replace-owned-file, dependency-recommendation
changes[].pathstringYesDefines the path value at this contract boundary.minLength: 1
changes[].summarystringYesDefines the summary value at this contract boundary.minLength: 1
filesarrayYesDefines the files value at this contract boundary.—
files[].overwriteenumYesDefines the overwrite value at this contract boundary.enum: create-only, replace-if-owned
files[].pathstringYesDefines the path value at this contract boundary.minLength: 1
files[].sha256stringYesDefines the sha256 value at this contract boundary.pattern: ^[a-f0-9]{64}$
frameworkVersionstringYesDefines the frameworkversion value at this contract boundary.minLength: 1
instanceNamestringYesDefines the instancename value at this contract boundary.pattern: ^[a-z0-9](?:[a-z0-9-]{0,46}[a-z0-9])?$
modeenumYesDefines the mode value at this contract boundary.enum: scaffold, attach
permissionsarrayYesDefines the permissions value at this contract boundary.—
projectRootstringYesDefines the projectroot value at this contract boundary.const: "."
requiredEnvironmentarrayYesDefines the requiredenvironment value at this contract boundary.minItems: 0
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspai.agent-framework-change-plan.v1"
statusenumYesDefines the status value at this contract boundary.enum: planned, blocked, no-op
targetobjectYesDefines the target value at this contract boundary.additionalProperties: false
target.artifactPrefixstringYesDefines the artifactprefix value at this contract boundary.minLength: 1
target.projectstringYesDefines the project 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/contracts/workspace-intelligence/agent-framework-change-plan.v1.json",
  "title": "Workspai Agent Framework Change Plan v1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "status",
    "adapterId",
    "adapterVersion",
    "frameworkVersion",
    "mode",
    "projectRoot",
    "target",
    "instanceName",
    "files",
    "changes",
    "requiredEnvironment",
    "permissions",
    "blockers"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.agent-framework-change-plan.v1"
    },
    "status": {
      "enum": [
        "planned",
        "blocked",
        "no-op"
      ]
    },
    "adapterId": {
      "type": "string",
      "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$"
    },
    "adapterVersion": {
      "type": "string",
      "minLength": 1
    },
    "frameworkVersion": {
      "type": "string",
      "minLength": 1
    },
    "mode": {
      "enum": [
        "scaffold",
        "attach"
      ]
    },
    "projectRoot": {
      "const": "."
    },
    "target": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "project",
        "artifactPrefix"
      ],
      "properties": {
        "project": {
          "type": "string",
          "minLength": 1
        },
        "artifactPrefix": {
          "type": "string",
          "minLength": 1,
          "not": {
            "anyOf": [
              {
                "pattern": "^/"
              },
              {
                "pattern": "^[A-Za-z]:[\\/]"
              },
              {
                "pattern": "(^|[\\/])\\.\\.([\\/]|$)"
              }
            ]
          }
        }
      }
    },
    "instanceName": {
      "type": "string",
      "pattern": "^[a-z0-9](?:[a-z0-9-]{0,46}[a-z0-9])?$"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "path",
          "sha256",
          "overwrite"
        ],
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1,
            "not": {
              "anyOf": [
                {
                  "pattern": "^/"
                },
                {
                  "pattern": "^[A-Za-z]:[\\/]"
                },
                {
                  "pattern": "(^|[\\/])\\.\\.([\\/]|$)"
                }
              ]
            }
          },
          "sha256": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "overwrite": {
            "enum": [
              "create-only",
              "replace-if-owned"
            ]
          }
        }
      }
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "kind",
          "path",
          "summary"
        ],
        "properties": {
          "kind": {
            "enum": [
              "create-file",
              "replace-owned-file",
              "dependency-recommendation"
            ]
          },
          "path": {
            "type": "string",
            "minLength": 1,
            "not": {
              "anyOf": [
                {
                  "pattern": "^/"
                },
                {
                  "pattern": "^[A-Za-z]:[\\/]"
                },
                {
                  "pattern": "(^|[\\/])\\.\\.([\\/]|$)"
                }
              ]
            }
          },
          "summary": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    },
    "requiredEnvironment": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 0,
      "uniqueItems": true
    },
    "permissions": {
      "type": "array",
      "items": {
        "enum": [
          "network:model-provider",
          "network:dependency-registry"
        ]
      },
      "uniqueItems": true
    },
    "blockers": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 0,
      "uniqueItems": true
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "status": {
            "const": "blocked"
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "blockers": {
            "type": "array",
            "minItems": 1
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "status": {
            "const": "planned"
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "changes": {
            "type": "array",
            "minItems": 1
          },
          "files": {
            "type": "array",
            "minItems": 1
          },
          "blockers": {
            "type": "array",
            "maxItems": 0
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "status": {
            "const": "no-op"
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "changes": {
            "type": "array",
            "maxItems": 0
          },
          "files": {
            "type": "array",
            "maxItems": 0
          },
          "blockers": {
            "type": "array",
            "maxItems": 0
          }
        }
      }
    }
  ]
}