Workspace Intelligence / JSON Schema

Workspai Goal Plan Result

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

Schema version: workspai.goal-plan-result.v1
Contract path: contracts/workspace-intelligence/goal-plan-result.v1.json
Publication: json-schema
Defined fields: 16
Artifact bindings: 0

Why this contract exists

Architecture role

Defines a versioned interoperability boundary used by Workspai and contract-aware consumers.

Consumption boundary

• Workspai CLI
• Workspace Intelligence consumers
• IDEs and agents

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 path	Type	Required	Meaning	Constraints
agentHandoff	object	Yes	Defines the agenthandoff value at this contract boundary.	—
agentHandoff.goalFingerprint	string	Yes	Defines the goalfingerprint value at this contract boundary.	pattern: ^[a-f0-9]{64}$
agentHandoff.goalId	string	Yes	Defines the goalid value at this contract boundary.	—
agentHandoff.schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.goal-agent-handoff.v1"
dryRun	boolean	Yes	Defines the dryrun value at this contract boundary.	—
goalPack	object	Yes	Defines the goalpack value at this contract boundary.	—
goalPack.fingerprint	string	Yes	Defines the fingerprint value at this contract boundary.	pattern: ^[a-f0-9]{64}$
goalPack.id	string	Yes	Defines the id value at this contract boundary.	—
goalPack.schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.goal-pack.v1"
resolution	object	Yes	Defines the resolution value at this contract boundary.	additionalProperties: false
resolution.invocationScope	enum	Yes	Defines the invocationscope value at this contract boundary.	enum: workspace, project
resolution.source	enum	Yes	Defines the source value at this contract boundary.	enum: explicit, parent, local-link, registry
result	enum	Yes	Defines the result value at this contract boundary.	enum: planned, needs-confirmation, needs-evidence, blocked
resumed	boolean	Yes	Defines the resumed value at this contract boundary.	—
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.goal-plan-result.v1"
writtenArtifacts	array	Yes	Defines the writtenartifacts value at this contract boundary.	—

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/workspace-intelligence/goal-plan-result.v1.json",
  "title": "Workspai Goal Plan Result",
  "type": "object",
  "required": [
    "schemaVersion",
    "result",
    "resolution",
    "goalPack",
    "agentHandoff",
    "writtenArtifacts",
    "dryRun",
    "resumed"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.goal-plan-result.v1"
    },
    "result": {
      "enum": [
        "planned",
        "needs-confirmation",
        "needs-evidence",
        "blocked"
      ]
    },
    "resolution": {
      "type": "object",
      "required": [
        "source",
        "invocationScope"
      ],
      "properties": {
        "source": {
          "enum": [
            "explicit",
            "parent",
            "local-link",
            "registry"
          ]
        },
        "invocationScope": {
          "enum": [
            "workspace",
            "project"
          ]
        }
      },
      "additionalProperties": false
    },
    "goalPack": {
      "type": "object",
      "required": [
        "schemaVersion",
        "id",
        "fingerprint"
      ],
      "properties": {
        "schemaVersion": {
          "const": "workspai.goal-pack.v1"
        },
        "id": {
          "type": "string"
        },
        "fingerprint": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      }
    },
    "agentHandoff": {
      "type": "object",
      "required": [
        "schemaVersion",
        "goalId",
        "goalFingerprint"
      ],
      "properties": {
        "schemaVersion": {
          "const": "workspai.goal-agent-handoff.v1"
        },
        "goalId": {
          "type": "string"
        },
        "goalFingerprint": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      }
    },
    "writtenArtifacts": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^\\.workspai/"
      },
      "uniqueItems": true
    },
    "dryRun": {
      "type": "boolean"
    },
    "resumed": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}