Workspace Intelligence / JSON Schema

Workspai Workspace Skills Index

Defines the versioned workspace skills index v1 boundary used by Workspai and its consumers.

Schema version: workspace-skills-index.v1
Contract path: contracts/workspace-intelligence/workspace-skills-index.v1.json
Publication: embedded-type, json-schema
Defined fields: 19
Artifact bindings: 1

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.

workspai workspace agent-sync

Produced artifacts

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

Artifact path	Schema	Producer
.workspai/reports/workspace-skills-index.json	workspace-skills-index.v1	workspai workspace agent-sync --write --json --preset enterprise

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
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
inputsHash	string	Yes	Defines the inputshash value at this contract boundary.	minLength: 8
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspace-skills-index.v1"
selection	object	No	Defines the selection value at this contract boundary.	additionalProperties: false
selection.decisions	array	Yes	Defines the decisions value at this contract boundary.	—
selection.decisions[].confidence	enum	Yes	Defines the confidence value at this contract boundary.	enum: high, medium
selection.decisions[].reasons	array	Yes	Defines the reasons value at this contract boundary.	—
selection.decisions[].scopedProjects	array	Yes	Defines the scopedprojects value at this contract boundary.	—
selection.decisions[].signals	array	Yes	Defines the signals value at this contract boundary.	—
selection.decisions[].skillId	string	Yes	Defines the skillid value at this contract boundary.	minLength: 1
selection.decisions[].status	enum	Yes	Defines the status value at this contract boundary.	enum: generated, suppressed
selection.decisions[].title	string	Yes	Defines the title value at this contract boundary.	—
selection.generatedCount	integer	Yes	Defines the generatedcount value at this contract boundary.	minimum: 0
selection.suppressedCount	integer	Yes	Defines the suppressedcount value at this contract boundary.	minimum: 0
skills	array	Yes	Defines the skills value at this contract boundary.	—
skills[].path	string	Yes	Defines the path value at this contract boundary.	—
skills[].schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	—
skills[].skillId	string	Yes	Defines the skillid value at this contract boundary.	—
skills[].title	string	Yes	Defines the title 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/workspace-skills-index.v1.json",
  "title": "Workspai Workspace Skills Index",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "inputsHash",
    "skills"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspace-skills-index.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "inputsHash": {
      "type": "string",
      "minLength": 8
    },
    "skills": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "skillId",
          "path",
          "schemaVersion",
          "title"
        ],
        "properties": {
          "skillId": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "schemaVersion": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "selection": {
      "type": "object",
      "required": [
        "generatedCount",
        "suppressedCount",
        "decisions"
      ],
      "properties": {
        "generatedCount": {
          "type": "integer",
          "minimum": 0
        },
        "suppressedCount": {
          "type": "integer",
          "minimum": 0
        },
        "decisions": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "skillId",
              "title",
              "status",
              "confidence",
              "reasons",
              "signals",
              "scopedProjects"
            ],
            "properties": {
              "skillId": {
                "type": "string",
                "minLength": 1
              },
              "title": {
                "type": "string"
              },
              "status": {
                "enum": [
                  "generated",
                  "suppressed"
                ]
              },
              "confidence": {
                "enum": [
                  "high",
                  "medium"
                ]
              },
              "reasons": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "signals": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "scopedProjects": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}