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 path | Type | Required | Meaning | Constraints |
|---|---|---|---|---|
| outputKinds | array | Yes | Published outputkinds capability data. | — |
| outputKinds[] | string | Yes | Published outputkinds[] capability data. | — |
| pathLayers | object | Yes | Published pathlayers capability data. | — |
| pathLayers.l1CanonicalRoots | array | Yes | Published l1canonicalroots capability data. | — |
| pathLayers.l1CanonicalRoots[] | string | Yes | Published l1canonicalroots[] capability data. | — |
| pathLayers.l2PrefixedMirrorRoots | array | Yes | Published l2prefixedmirrorroots capability data. | — |
| pathLayers.l2PrefixedMirrorRoots[] | string | Yes | Published l2prefixedmirrorroots[] capability data. | — |
| pathLayers.l3SharedIndustryFiles | array | Yes | Published l3sharedindustryfiles capability data. | — |
| pathLayers.l3SharedIndustryFiles[] | string | Yes | Published l3sharedindustryfiles[] capability data. | — |
| presets | object | Yes | Published presets capability data. | — |
| presets.enterprise | object | Yes | Published enterprise capability data. | — |
| presets.enterprise.meaning | string | Yes | Published meaning capability data. | — |
| presets.enterprise.requiredOutputs | array | Yes | Published requiredoutputs capability data. | — |
| presets.enterprise.requiredOutputs[] | string | Yes | Published requiredoutputs[] capability data. | — |
| presets.minimal | object | Yes | Published minimal capability data. | — |
| presets.minimal.meaning | string | Yes | Published meaning capability data. | — |
| presets.minimal.requiredOutputs | array | Yes | Published requiredoutputs capability data. | — |
| presets.minimal.requiredOutputs[] | string | Yes | Published requiredoutputs[] capability data. | — |
| requiredReports | array | Yes | Published requiredreports capability data. | — |
| requiredReports[] | object | Yes | Published requiredreports[] capability data. | — |
| requiredReports[].label | string | Yes | Published label capability data. | — |
| requiredReports[].path | string | Yes | Published path capability data. | — |
| requiredReports[].required | boolean | Yes | Published required capability data. | — |
| schemaVersion | string | Yes | Published schemaversion capability data. | — |
| standardAnswerContract | array | Yes | Published standardanswercontract capability data. | — |
| standardAnswerContract[] | string | Yes | Published standardanswercontract[] capability data. | — |
| strictRules | array | Yes | Published strictrules capability data. | — |
| strictRules[] | string | Yes | Published strictrules[] capability data. | — |
| targets | object | Yes | Published targets capability data. | — |
| targets.agents | object | Yes | Published agents capability data. | — |
| targets.agents.meaning | string | Yes | Published meaning capability data. | — |
| targets.agents.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.agents.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.all | object | Yes | Published all capability data. | — |
| targets.all.meaning | string | Yes | Published meaning capability data. | — |
| targets.all.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.all.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.claude | object | Yes | Published claude capability data. | — |
| targets.claude.meaning | string | Yes | Published meaning capability data. | — |
| targets.claude.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.claude.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.codex | object | Yes | Published codex capability data. | — |
| targets.codex.meaning | string | Yes | Published meaning capability data. | — |
| targets.codex.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.codex.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.copilot | object | Yes | Published copilot capability data. | — |
| targets.copilot.meaning | string | Yes | Published meaning capability data. | — |
| targets.copilot.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.copilot.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.cursor | object | Yes | Published cursor capability data. | — |
| targets.cursor.meaning | string | Yes | Published meaning capability data. | — |
| targets.cursor.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.cursor.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.orca | object | Yes | Published orca capability data. | — |
| targets.orca.meaning | string | Yes | Published meaning capability data. | — |
| targets.orca.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.orca.outputFamilies[] | string | Yes | Published outputfamilies[] capability data. | — |
| targets.vscode | object | Yes | Published vscode capability data. | — |
| targets.vscode.meaning | string | Yes | Published meaning capability data. | — |
| targets.vscode.outputFamilies | array | Yes | Published outputfamilies capability data. | — |
| targets.vscode.outputFamilies[] | string | Yes | Published 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"
]
}
}