All contracts

Workspace Intelligence / JSON Schema

Workspai Agent Framework Conformance Report v1

Defines the versioned agent framework conformance report v1 boundary used by Workspai and its consumers.

Schema version
workspai.agent-framework-conformance-report.v1
Contract path
contracts/workspace-intelligence/agent-framework-conformance-report.v1.json
Publication
json-schema
Defined fields
29
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
adapterobjectYesDefines the adapter value at this contract boundary.additionalProperties: false
adapter.idstringYesDefines the id value at this contract boundary.pattern: ^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$
adapter.manifestSha256stringYesDefines the manifestsha256 value at this contract boundary.pattern: ^[a-f0-9]{64}$
adapter.versionstringYesDefines the version value at this contract boundary.minLength: 1
blockersarrayYesDefines the blockers value at this contract boundary.minItems: 0
checksarrayYesDefines the checks value at this contract boundary.minItems: 18
checks[].durationMsnumberYesDefines the durationms value at this contract boundary.minimum: 0
checks[].evidencePathsarrayYesDefines the evidencepaths value at this contract boundary.minItems: 1
checks[].idenumYesDefines the id value at this contract boundary.enum: manifest-schema, protocol-version, capability-truth, detection-positive, detection-negative, scaffold-plan-safety, attach-plan-safety, managed-file-ownership, user-file-preservation, path-containment, secret-non-persistence, context-generation-binding, mutation-gateway, verification-binding, failure-isolation, idempotency, offline-posture, cross-platform-paths
checks[].requiredbooleanYesDefines the required value at this contract boundary.—
checks[].statusenumYesDefines the status value at this contract boundary.enum: passed, failed, skipped
checks[].summarystringYesDefines the summary value at this contract boundary.minLength: 1
cliVersionstringYesDefines the cliversion value at this contract boundary.minLength: 1
environmentobjectYesDefines the environment value at this contract boundary.additionalProperties: false
environment.architecturestringYesDefines the architecture value at this contract boundary.minLength: 1
environment.platformenumYesDefines the platform value at this contract boundary.enum: linux, darwin, win32
environment.runtimestringYesDefines the runtime value at this contract boundary.minLength: 1
environment.runtimeVersionstringYesDefines the runtimeversion value at this contract boundary.minLength: 1
frameworkVersionstringYesDefines the frameworkversion value at this contract boundary.minLength: 1
generatedAtstringYesDefines the generatedat value at this contract boundary.format: date-time
limitationsarrayYesDefines the limitations value at this contract boundary.minItems: 0
protocolVersionstringYesDefines the protocolversion value at this contract boundary.const: "workspai.agent-framework-adapter-protocol.v1"
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspai.agent-framework-conformance-report.v1"
summaryobjectYesDefines the summary value at this contract boundary.additionalProperties: false
summary.failedintegerYesDefines the failed value at this contract boundary.minimum: 0
summary.passedintegerYesDefines the passed value at this contract boundary.minimum: 0
summary.requiredintegerYesDefines the required value at this contract boundary.minimum: 18
summary.skippedintegerYesDefines the skipped value at this contract boundary.minimum: 0
verdictenumYesDefines the verdict value at this contract boundary.enum: admitted, blocked

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-conformance-report.v1.json",
  "title": "Workspai Agent Framework Conformance Report v1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "protocolVersion",
    "generatedAt",
    "adapter",
    "frameworkVersion",
    "cliVersion",
    "environment",
    "checks",
    "summary",
    "verdict",
    "blockers",
    "limitations"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.agent-framework-conformance-report.v1"
    },
    "protocolVersion": {
      "const": "workspai.agent-framework-adapter-protocol.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "adapter": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "version",
        "manifestSha256"
      ],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$"
        },
        "version": {
          "type": "string",
          "minLength": 1
        },
        "manifestSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      }
    },
    "frameworkVersion": {
      "type": "string",
      "minLength": 1
    },
    "cliVersion": {
      "type": "string",
      "minLength": 1
    },
    "environment": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "platform",
        "architecture",
        "runtime",
        "runtimeVersion"
      ],
      "properties": {
        "platform": {
          "enum": [
            "linux",
            "darwin",
            "win32"
          ]
        },
        "architecture": {
          "type": "string",
          "minLength": 1
        },
        "runtime": {
          "type": "string",
          "minLength": 1
        },
        "runtimeVersion": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "checks": {
      "type": "array",
      "minItems": 18,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "status",
          "required",
          "summary",
          "evidencePaths",
          "durationMs"
        ],
        "properties": {
          "id": {
            "enum": [
              "manifest-schema",
              "protocol-version",
              "capability-truth",
              "detection-positive",
              "detection-negative",
              "scaffold-plan-safety",
              "attach-plan-safety",
              "managed-file-ownership",
              "user-file-preservation",
              "path-containment",
              "secret-non-persistence",
              "context-generation-binding",
              "mutation-gateway",
              "verification-binding",
              "failure-isolation",
              "idempotency",
              "offline-posture",
              "cross-platform-paths"
            ]
          },
          "status": {
            "enum": [
              "passed",
              "failed",
              "skipped"
            ]
          },
          "required": {
            "type": "boolean"
          },
          "summary": {
            "type": "string",
            "minLength": 1
          },
          "evidencePaths": {
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
              "type": "string",
              "minLength": 1,
              "not": {
                "anyOf": [
                  {
                    "pattern": "^/"
                  },
                  {
                    "pattern": "^[A-Za-z]:[\\\\/]"
                  },
                  {
                    "pattern": "(^|[\\\\/])\\.\\.([\\\\/]|$)"
                  }
                ]
              }
            }
          },
          "durationMs": {
            "type": "number",
            "minimum": 0
          }
        }
      }
    },
    "summary": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "passed",
        "failed",
        "skipped",
        "required"
      ],
      "properties": {
        "passed": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "skipped": {
          "type": "integer",
          "minimum": 0
        },
        "required": {
          "type": "integer",
          "minimum": 18
        }
      }
    },
    "verdict": {
      "enum": [
        "admitted",
        "blocked"
      ]
    },
    "blockers": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 0,
      "uniqueItems": true
    },
    "limitations": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 0,
      "uniqueItems": true
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "verdict": {
            "const": "blocked"
          }
        },
        "required": [
          "verdict"
        ]
      },
      "then": {
        "properties": {
          "blockers": {
            "type": "array",
            "minItems": 1
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "verdict": {
            "const": "admitted"
          }
        },
        "required": [
          "verdict"
        ]
      },
      "then": {
        "properties": {
          "blockers": {
            "type": "array",
            "maxItems": 0
          }
        }
      }
    }
  ]
}