All contracts

Agent grounding / Capability contract

Agent Customization Pack V1

Defines the versioned agent customization pack v1 boundary used by Workspai and its consumers.

Schema version
workspai-agent-customization-pack-capabilities.v1
Contract path
contracts/agent-customization-pack.v1.json
Publication
capability-contract
Defined fields
61
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
outputKindsarrayYesPublished outputkinds capability data.
outputKinds[]stringYesPublished outputkinds[] capability data.
pathLayersobjectYesPublished pathlayers capability data.
pathLayers.l1CanonicalRootsarrayYesPublished l1canonicalroots capability data.
pathLayers.l1CanonicalRoots[]stringYesPublished l1canonicalroots[] capability data.
pathLayers.l2PrefixedMirrorRootsarrayYesPublished l2prefixedmirrorroots capability data.
pathLayers.l2PrefixedMirrorRoots[]stringYesPublished l2prefixedmirrorroots[] capability data.
pathLayers.l3SharedIndustryFilesarrayYesPublished l3sharedindustryfiles capability data.
pathLayers.l3SharedIndustryFiles[]stringYesPublished l3sharedindustryfiles[] capability data.
presetsobjectYesPublished presets capability data.
presets.enterpriseobjectYesPublished enterprise capability data.
presets.enterprise.meaningstringYesPublished meaning capability data.
presets.enterprise.requiredOutputsarrayYesPublished requiredoutputs capability data.
presets.enterprise.requiredOutputs[]stringYesPublished requiredoutputs[] capability data.
presets.minimalobjectYesPublished minimal capability data.
presets.minimal.meaningstringYesPublished meaning capability data.
presets.minimal.requiredOutputsarrayYesPublished requiredoutputs capability data.
presets.minimal.requiredOutputs[]stringYesPublished requiredoutputs[] capability data.
requiredReportsarrayYesPublished requiredreports capability data.
requiredReports[]objectYesPublished requiredreports[] capability data.
requiredReports[].labelstringYesPublished label capability data.
requiredReports[].pathstringYesPublished path capability data.
requiredReports[].requiredbooleanYesPublished required capability data.
schemaVersionstringYesPublished schemaversion capability data.
standardAnswerContractarrayYesPublished standardanswercontract capability data.
standardAnswerContract[]stringYesPublished standardanswercontract[] capability data.
strictRulesarrayYesPublished strictrules capability data.
strictRules[]stringYesPublished strictrules[] capability data.
targetsobjectYesPublished targets capability data.
targets.agentsobjectYesPublished agents capability data.
targets.agents.meaningstringYesPublished meaning capability data.
targets.agents.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.agents.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.allobjectYesPublished all capability data.
targets.all.meaningstringYesPublished meaning capability data.
targets.all.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.all.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.claudeobjectYesPublished claude capability data.
targets.claude.meaningstringYesPublished meaning capability data.
targets.claude.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.claude.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.codexobjectYesPublished codex capability data.
targets.codex.meaningstringYesPublished meaning capability data.
targets.codex.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.codex.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.copilotobjectYesPublished copilot capability data.
targets.copilot.meaningstringYesPublished meaning capability data.
targets.copilot.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.copilot.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.cursorobjectYesPublished cursor capability data.
targets.cursor.meaningstringYesPublished meaning capability data.
targets.cursor.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.cursor.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.orcaobjectYesPublished orca capability data.
targets.orca.meaningstringYesPublished meaning capability data.
targets.orca.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.orca.outputFamilies[]stringYesPublished outputfamilies[] capability data.
targets.vscodeobjectYesPublished vscode capability data.
targets.vscode.meaningstringYesPublished meaning capability data.
targets.vscode.outputFamiliesarrayYesPublished outputfamilies capability data.
targets.vscode.outputFamilies[]stringYesPublished outputfamilies[] capability data.

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON
{
  "schemaVersion": "workspai-agent-customization-pack-capabilities.v1",
  "presets": {
    "minimal": {
      "meaning": "Generate the portable grounding index, AGENTS.md, and provider-specific lightweight instructions.",
      "requiredOutputs": [
        ".workspai/reports/INDEX.json",
        ".workspai/reports/agent-customization-pack.json",
        "AGENTS.md"
      ]
    },
    "enterprise": {
      "meaning": "Generate the full VS Code-native pack: instructions, prompts, skills, custom agents, and validation metadata.",
      "requiredOutputs": [
        ".workspai/reports/INDEX.json",
        ".workspai/reports/agent-customization-pack.json",
        "AGENTS.md",
        ".github/instructions/workspai-workspace.instructions.md",
        ".github/prompts/workspai-diagnose.prompt.md",
        ".github/skills/workspai-workspace-intelligence/SKILL.md",
        ".github/agents/workspai-advisor.agent.md",
        ".workspai/reports/workspai-mcp-design.json",
        ".workspai/reports/workspace-skills-index.json"
      ]
    }
  },
  "targets": {
    "all": {
      "meaning": "Generate every supported customization surface.",
      "outputFamilies": [
        "portable",
        "vscode",
        "copilot",
        "cursor",
        "claude"
      ]
    },
    "vscode": {
      "meaning": "Generate VS Code-native customizations for Copilot Chat and agent workflows.",
      "outputFamilies": [
        "instructions",
        "prompts",
        "skills",
        "agents",
        "hooks"
      ]
    },
    "agents": {
      "meaning": "Generate portable AGENTS.md grounding for any agent.",
      "outputFamilies": [
        "portable"
      ]
    },
    "copilot": {
      "meaning": "Generate GitHub Copilot instructions, prompts, and skills.",
      "outputFamilies": [
        "instructions",
        "prompts",
        "skills"
      ]
    },
    "cursor": {
      "meaning": "Generate Cursor rules.",
      "outputFamilies": [
        "rules"
      ]
    },
    "claude": {
      "meaning": "Generate Claude Code grounding files.",
      "outputFamilies": [
        "rules",
        "portable"
      ]
    },
    "codex": {
      "meaning": "Use AGENTS.md and the report index as the Codex grounding layer.",
      "outputFamilies": [
        "portable"
      ]
    },
    "orca": {
      "meaning": "Use AGENTS.md and the report index as the Orca/Grok grounding layer.",
      "outputFamilies": [
        "portable"
      ]
    }
  },
  "standardAnswerContract": [
    "Scope",
    "Evidence",
    "Diagnosis",
    "Fix Plan",
    "Run",
    "Verify",
    "Assumptions"
  ],
  "requiredReports": [
    {
      "path": ".workspai/reports/workspace-context-agent.json",
      "label": "Agent context pack",
      "required": true
    },
    {
      "path": ".workspai/reports/workspace-skills-index.json",
      "label": "Operational skills index",
      "required": true
    },
    {
      "path": ".workspai/reports/workspace-model.json",
      "label": "Workspace model graph",
      "required": false
    },
    {
      "path": ".workspai/reports/doctor-last-run.json",
      "label": "Workspace doctor",
      "required": false
    },
    {
      "path": ".workspai/reports/doctor-project-last-run.json",
      "label": "Project doctor",
      "required": false
    },
    {
      "path": ".workspai/reports/doctor-remediation-plan-last-run.json",
      "label": "Doctor remediation plan",
      "required": false
    },
    {
      "path": ".workspai/reports/artifact-remediation-plan-last-run.json",
      "label": "Artifact remediation plan",
      "required": false
    },
    {
      "path": ".workspai/reports/doctor-fix-result-last-run.json",
      "label": "Doctor fix result",
      "required": false
    },
    {
      "path": ".workspai/reports/analyze-last-run.json",
      "label": "Workspace analyze",
      "required": false
    },
    {
      "path": ".workspai/reports/pipeline-last-run.json",
      "label": "Governance pipeline",
      "required": false
    },
    {
      "path": ".workspai/reports/release-readiness-last-run.json",
      "label": "Release readiness",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-impact-last-run.json",
      "label": "Workspace impact",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-verify-last-run.json",
      "label": "Workspace verify",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-model-snapshot.json",
      "label": "Workspace model snapshot",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-model-diff-last-run.json",
      "label": "Workspace model diff",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-explain-last-run.json",
      "label": "Workspace explain",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-contract-verify-last-run.json",
      "label": "Workspace contract verify",
      "required": false
    },
    {
      "path": ".workspai/reports/workspace-intelligence-history.json",
      "label": "Workspace intelligence history",
      "required": false
    }
  ],
  "strictRules": [
    "Required reports must exist.",
    "Generated report paths must stay inside the workspace root.",
    "Generated customization text must be English-only.",
    "Agent answers must not claim pass, ready, or healthy without cited evidence.",
    "Commands must distinguish display guidance from execution requests.",
    "Agent hook files must be advisory and disabled by default unless the user explicitly enables them.",
    "MCP design artifacts must stay read-mostly until write tools have explicit approval boundaries."
  ],
  "outputKinds": [
    "report",
    "grounding",
    "instruction",
    "prompt",
    "skill",
    "skill-resource",
    "operational-skill",
    "skills-index",
    "explain-report",
    "agent",
    "rule",
    "hook",
    "mcp-design"
  ],
  "pathLayers": {
    "l1CanonicalRoots": [
      ".workspai/reports/",
      ".workspai/skills/"
    ],
    "l2PrefixedMirrorRoots": [
      ".github/",
      ".cursor/",
      ".claude/"
    ],
    "l3SharedIndustryFiles": [
      "AGENTS.md",
      ".github/copilot-instructions.md",
      "CLAUDE.md"
    ]
  }
}