Workspace Intelligence / JSON Schema

RapidKit Agent Action Outcome

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

Schema version: agent-action-outcome.v1
Contract path: contracts/workspace-intelligence/agent-action-outcome.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 path	Type	Required	Meaning	Constraints
actionId	string	Yes	Defines the actionid value at this contract boundary.	minLength: 1
affectedFiles	array	No	Defines the affectedfiles value at this contract boundary.	—
commandsRun	array	No	Defines the commandsrun value at this contract boundary.	—
evidencePath	string	No	Defines the evidencepath value at this contract boundary.	—
evidenceSha256	string	No	Defines the evidencesha256 value at this contract boundary.	pattern: ^[a-f0-9]{64}$
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
outcome	enum	Yes	Defines the outcome value at this contract boundary.	enum: ok, failed
patchMetadata	object	No	Defines the patchmetadata value at this contract boundary.	additionalProperties: false
patchMetadata.affectedFiles	array	Yes	Defines the affectedfiles value at this contract boundary.	—
patchMetadata.appliedCount	integer	Yes	Defines the appliedcount value at this contract boundary.	minimum: 0
patchMetadata.branchCreated	string	No	Defines the branchcreated value at this contract boundary.	—
patchMetadata.failedCount	integer	Yes	Defines the failedcount value at this contract boundary.	minimum: 0
patchMetadata.patchId	string	No	Defines the patchid value at this contract boundary.	—
patchMetadata.rejectedCount	integer	Yes	Defines the rejectedcount value at this contract boundary.	minimum: 0
patchMetadata.reviewRequired	boolean	No	Defines the reviewrequired value at this contract boundary.	—
patchMetadata.rollbackCommand	string	No	Defines the rollbackcommand value at this contract boundary.	—
patchMetadata.sourceAction	enum	No	Defines the sourceaction value at this contract boundary.	enum: auto-fix, apply-patch
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "agent-action-outcome.v1"
scope	string	Yes	Defines the scope value at this contract boundary.	—
summary	string	Yes	Defines the summary value at this contract boundary.	—
verifyAfter	string	No	Defines the verifyafter value at this contract boundary.	—
verifyBefore	string	No	Defines the verifybefore 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://getrapidkit.com/schemas/agent-action-outcome.v1.json",
  "title": "RapidKit Agent Action Outcome",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "actionId",
    "scope",
    "summary",
    "outcome"
  ],
  "properties": {
    "schemaVersion": {
      "const": "agent-action-outcome.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "actionId": {
      "type": "string",
      "minLength": 1
    },
    "scope": {
      "type": "string"
    },
    "summary": {
      "type": "string"
    },
    "outcome": {
      "enum": [
        "ok",
        "failed"
      ]
    },
    "affectedFiles": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "commandsRun": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "verifyBefore": {
      "type": "string"
    },
    "verifyAfter": {
      "type": "string"
    },
    "evidenceSha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "evidencePath": {
      "type": "string"
    },
    "patchMetadata": {
      "type": "object",
      "required": [
        "appliedCount",
        "rejectedCount",
        "failedCount",
        "affectedFiles"
      ],
      "properties": {
        "patchId": {
          "type": "string"
        },
        "sourceAction": {
          "enum": [
            "auto-fix",
            "apply-patch"
          ]
        },
        "reviewRequired": {
          "type": "boolean"
        },
        "branchCreated": {
          "type": "string"
        },
        "appliedCount": {
          "type": "integer",
          "minimum": 0
        },
        "rejectedCount": {
          "type": "integer",
          "minimum": 0
        },
        "failedCount": {
          "type": "integer",
          "minimum": 0
        },
        "affectedFiles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "rollbackCommand": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}