All contracts

Workspace Intelligence / JSON Schema

Workspai Workspace Operational Skill

Defines the versioned workspace operational skill v1 boundary used by Workspai and its consumers.

Schema version
workspace-operational-skill.v1
Contract path
contracts/workspace-intelligence/workspace-operational-skill.v1.json
Publication
json-schema
Defined fields
11
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
answerContractSectionsarrayYesDefines the answercontractsections value at this contract boundary.
canonicalPathstringYesDefines the canonicalpath value at this contract boundary.pattern: ^\.workspai/skills/[^/]+\.md$
markdownstringYesDefines the markdown value at this contract boundary.
promptStemstringNoDefines the promptstem value at this contract boundary.
requiredReportsarrayYesDefines the requiredreports value at this contract boundary.
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspace-operational-skill.v1"
scopedProjectsarrayYesDefines the scopedprojects value at this contract boundary.
skillIdstringYesDefines the skillid value at this contract boundary.minLength: 1
titlestringYesDefines the title value at this contract boundary.
triggersarrayYesDefines the triggers value at this contract boundary.
verificationCommandsarrayYesDefines the verificationcommands 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/workspace-operational-skill.v1.json",
  "title": "Workspai Workspace Operational Skill",
  "type": "object",
  "required": [
    "schemaVersion",
    "skillId",
    "canonicalPath",
    "title",
    "triggers",
    "requiredReports",
    "scopedProjects",
    "verificationCommands",
    "answerContractSections",
    "markdown"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspace-operational-skill.v1"
    },
    "skillId": {
      "type": "string",
      "minLength": 1
    },
    "canonicalPath": {
      "type": "string",
      "pattern": "^\\.workspai/skills/[^/]+\\.md$"
    },
    "title": {
      "type": "string"
    },
    "triggers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "requiredReports": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "scopedProjects": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "verificationCommands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "answerContractSections": {
      "type": "array",
      "items": {
        "enum": [
          "Scope",
          "Evidence",
          "Diagnosis",
          "Fix Plan",
          "Run",
          "Verify",
          "Assumptions"
        ]
      }
    },
    "promptStem": {
      "type": "string"
    },
    "markdown": {
      "type": "string"
    }
  },
  "additionalProperties": false
}