Skip to content

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

Closed
Copilot wants to merge 4 commits intomainfrom
copilot/add-engine-compatibility-metadata
Closed

Add engine compatibility metadata to schema via $comment fields#7596
Copilot wants to merge 4 commits intomainfrom
copilot/add-engine-compatibility-metadata

Conversation

Copy link
Contributor

Copilot AI commented Dec 25, 2025

Users configure engine-specific features without visibility into which engines support them, discovering incompatibilities only at runtime.

Changes

Added $comment fields to document engine compatibility at schema definition sites:

  • engine field: Feature matrix showing HTTP transport (copilot/claude/codex), max-turns (claude), firewall (copilot/claude/codex), SRT (copilot)
  • network.firewall: Supported on copilot, claude, codex only
  • sandbox: SRT is copilot-only; AWF supported on copilot, claude, codex
  • engine.max-turns: Claude-only feature
  • http_mcp_tool: HTTP transport supported on copilot, claude, codex

Each comment includes source code references for verification (e.g., pkg/workflow/firewall.go:89).

IDE Integration

IDEs with JSON Schema support (VS Code + YAML extension) now show compatibility tooltips on hover:

---
engine:
  id: claude
  max-turns: 15  # Tooltip: "Engine compatibility: claude only. See agent_validation.go:143"
---

Binary rebuilt with make build to embed updated schema.

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Document engine-specific feature compatibility in schema</issue_title>
<issue_description>## Objective

Add engine compatibility metadata to schema $comment fields for features that only work on specific engines.

Context

Multiple features are engine-specific (firewall only works on copilot and codex, sandbox only on copilot), but the schema provides no compatibility information. Users configure unsupported features and only discover the incompatibility at runtime or through obscure errors.

Engine-Locked Features to Document

Feature Supported Engines Code Reference
firewall copilot, codex pkg/workflow/firewall.go:89,105
sandbox copilot pkg/workflow/firewall.go:135
HTTP transport variations Engine-specific pkg/workflow/engine_validation.go
max-turns behavior Engine-specific pkg/workflow/agent_validation.go:143

Approach

Add $comment metadata to each feature's schema definition:

{
  "firewall": {
    "type": "object",
    "$comment": "Engine compatibility: copilot, codex only. Not supported on claude or custom engines. See pkg/workflow/firewall.go:89",
    "properties": { ... }
  }
}

For the engine field itself, add a compatibility matrix:

{
  "engine": {
    "type": "string",
    "enum": ["copilot", "claude", "codex", "custom"],
    "$comment": "Feature compatibility by engine: firewall (copilot, codex), sandbox (copilot only), http-transport (varies)"
  }
}

Files to Modify

  • pkg/parser/schemas/frontmatter.json - Add $comment fields
  • After changes, run make build to rebuild with embedded schema

Acceptance Criteria

  • All engine-specific features have $comment compatibility notes
  • Comments reference code locations for verification
  • Engine field has feature compatibility matrix
  • Documentation updated to reference schema comments

Testing

Review schema with IDE that displays $comment fields to verify visibility.
Related to #7575

AI generated by Plan Command for discussion #7569

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits December 25, 2025 07:03
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add engine compatibility metadata to schema comment fields Add engine compatibility metadata to schema via $comment fields Dec 25, 2025
Copilot AI requested a review from mnkiefer December 25, 2025 07:16
@pelikhan pelikhan closed this Dec 25, 2025
@github-actions github-actions bot deleted the copilot/add-engine-compatibility-metadata branch January 10, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[plan] Document engine-specific feature compatibility in schema

3 participants