Skip to content

Add engine compatibility metadata to schema via $comment fields #7596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 4 commits into from
Closed

Add engine compatibility metadata to schema via $comment fields #7596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7244f74
Initial plan
Copilot Dec 25, 2025
1de775e
Initial plan for adding engine compatibility metadata to schema
Copilot Dec 25, 2025
dc0c487
Add engine-specific feature compatibility metadata to schema
Copilot Dec 25, 2025
b741ea9
Final verification: schema validated and recompiled successfully
Copilot Dec 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/aw/schemas/agentic-workflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1903,6 +1903,7 @@
},
"firewall": {
"description": "AWF (Agent Workflow Firewall) configuration for network egress control. Only supported for Copilot engine.",
"$comment": "Engine compatibility: copilot, claude, codex only. Not supported on custom engine. See pkg/workflow/firewall.go:89,105",
"deprecated": true,
"x-deprecation-message": "Use 'sandbox.agent: false' instead to disable the firewall for the agent",
"oneOf": [
Expand Down Expand Up @@ -1952,6 +1953,7 @@
},
"sandbox": {
"description": "Sandbox configuration for AI engines. Controls agent sandbox (AWF or Sandbox Runtime) and MCP gateway.",
"$comment": "Engine compatibility: Sandbox Runtime (SRT) is copilot only. AWF firewall supported on copilot, claude, codex. See pkg/workflow/firewall.go:135",
"oneOf": [
{
"type": "string",
Expand Down Expand Up @@ -2296,6 +2298,7 @@
},
"engine": {
"description": "AI engine configuration that specifies which AI processor interprets and executes the markdown content of the workflow. Defaults to 'copilot'.",
"$comment": "Engine-specific feature compatibility: HTTP transport (copilot, claude, codex), max-turns (claude only), firewall/AWF (copilot, claude, codex), Sandbox Runtime/SRT (copilot only). See pkg/workflow/copilot_engine.go, pkg/workflow/claude_engine.go, pkg/workflow/codex_engine.go",
"default": "copilot",
"$ref": "#/$defs/engine_config"
},
Expand Down Expand Up @@ -5195,7 +5198,8 @@
"description": "Maximum number of chat iterations per run as a string value"
}
],
"description": "Maximum number of chat iterations per run. Helps prevent runaway loops and control costs. Has sensible defaults and can typically be omitted. Note: Only supported by the claude engine."
"description": "Maximum number of chat iterations per run. Helps prevent runaway loops and control costs. Has sensible defaults and can typically be omitted. Note: Only supported by the claude engine.",
"$comment": "Engine compatibility: claude only. Not supported on copilot, codex, or custom engines. See pkg/workflow/agent_validation.go:143"
},
"concurrency": {
"oneOf": [
Expand Down Expand Up @@ -5432,6 +5436,7 @@
"http_mcp_tool": {
"type": "object",
"description": "HTTP MCP tool configuration",
"$comment": "Engine compatibility: HTTP transport is supported on copilot, claude, and codex engines. Not supported on custom engine. See pkg/workflow/agent_validation.go:118-134",
"properties": {
"type": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/issue-classifier.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions .github/workflows/release.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/stale-repo-identifier.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/super-linter.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 13 additions & 29 deletions pkg/parser/schemas/main_workflow_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,10 +285,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["branches"] },
{ "required": ["branches-ignore"] }
]
"anyOf": [{ "required": ["branches"] }, { "required": ["branches-ignore"] }]
}
}
],
Expand All @@ -305,10 +302,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["paths"] },
{ "required": ["paths-ignore"] }
]
"anyOf": [{ "required": ["paths"] }, { "required": ["paths-ignore"] }]
}
}
]
Expand Down Expand Up @@ -431,10 +425,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["branches"] },
{ "required": ["branches-ignore"] }
]
"anyOf": [{ "required": ["branches"] }, { "required": ["branches-ignore"] }]
}
}
],
Expand All @@ -451,10 +442,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["paths"] },
{ "required": ["paths-ignore"] }
]
"anyOf": [{ "required": ["paths"] }, { "required": ["paths-ignore"] }]
}
}
]
Expand Down Expand Up @@ -669,10 +657,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["branches"] },
{ "required": ["branches-ignore"] }
]
"anyOf": [{ "required": ["branches"] }, { "required": ["branches-ignore"] }]
}
}
]
Expand Down Expand Up @@ -996,10 +981,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["branches"] },
{ "required": ["branches-ignore"] }
]
"anyOf": [{ "required": ["branches"] }, { "required": ["branches-ignore"] }]
}
}
],
Expand All @@ -1016,10 +998,7 @@
},
{
"not": {
"anyOf": [
{ "required": ["paths"] },
{ "required": ["paths-ignore"] }
]
"anyOf": [{ "required": ["paths"] }, { "required": ["paths-ignore"] }]
}
}
]
Expand Down Expand Up @@ -1903,6 +1882,7 @@
},
"firewall": {
"description": "AWF (Agent Workflow Firewall) configuration for network egress control. Only supported for Copilot engine.",
"$comment": "Engine compatibility: copilot, claude, codex only. Not supported on custom engine. See pkg/workflow/firewall.go:89,105",
"deprecated": true,
"x-deprecation-message": "Use 'sandbox.agent: false' instead to disable the firewall for the agent",
"oneOf": [
Expand Down Expand Up @@ -1952,6 +1932,7 @@
},
"sandbox": {
"description": "Sandbox configuration for AI engines. Controls agent sandbox (AWF or Sandbox Runtime) and MCP gateway.",
"$comment": "Engine compatibility: Sandbox Runtime (SRT) is copilot only. AWF firewall supported on copilot, claude, codex. See pkg/workflow/firewall.go:135",
"oneOf": [
{
"type": "string",
Expand Down Expand Up @@ -2296,6 +2277,7 @@
},
"engine": {
"description": "AI engine configuration that specifies which AI processor interprets and executes the markdown content of the workflow. Defaults to 'copilot'.",
"$comment": "Engine-specific feature compatibility: HTTP transport (copilot, claude, codex), max-turns (claude only), firewall/AWF (copilot, claude, codex), Sandbox Runtime/SRT (copilot only). See pkg/workflow/copilot_engine.go, pkg/workflow/claude_engine.go, pkg/workflow/codex_engine.go",
"default": "copilot",
"$ref": "#/$defs/engine_config"
},
Expand Down Expand Up @@ -5195,7 +5177,8 @@
"description": "Maximum number of chat iterations per run as a string value"
}
],
"description": "Maximum number of chat iterations per run. Helps prevent runaway loops and control costs. Has sensible defaults and can typically be omitted. Note: Only supported by the claude engine."
"description": "Maximum number of chat iterations per run. Helps prevent runaway loops and control costs. Has sensible defaults and can typically be omitted. Note: Only supported by the claude engine.",
"$comment": "Engine compatibility: claude only. Not supported on copilot, codex, or custom engines. See pkg/workflow/agent_validation.go:143"
},
"concurrency": {
"oneOf": [
Expand Down Expand Up @@ -5432,6 +5415,7 @@
"http_mcp_tool": {
"type": "object",
"description": "HTTP MCP tool configuration",
"$comment": "Engine compatibility: HTTP transport is supported on copilot, claude, and codex engines. Not supported on custom engine. See pkg/workflow/agent_validation.go:118-134",
"properties": {
"type": {
"type": "string",
Expand Down