All contracts

Workspace Intelligence / JSON Schema

Mcp Design V1

Defines the versioned mcp design v1 boundary used by Workspai and its consumers.

Schema version
workspai-mcp-design.v1
Contract path
contracts/workspace-intelligence/mcp-design.v1.json
Publication
json-schema
Defined fields
7
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
candidateToolsarrayYesDefines the candidatetools value at this contract boundary.
generatedAtstringYesDefines the generatedat value at this contract boundary.format: date-time
modestringYesDefines the mode value at this contract boundary.const: "read-mostly"
safetyobjectYesDefines the safety value at this contract boundary.
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspai-mcp-design.v1"
statusstringYesDefines the status value at this contract boundary.const: "design-only"
workspaceRootstringYesDefines the workspaceroot value at this contract boundary.minLength: 1

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",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspaceRoot",
    "status",
    "mode",
    "safety",
    "candidateTools"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai-mcp-design.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspaceRoot": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "const": "design-only"
    },
    "mode": {
      "const": "read-mostly"
    },
    "safety": {
      "type": "object"
    },
    "candidateTools": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "additionalProperties": true
}