Skip to content

[Code Quality] Add schema examples for MCP env field to improve IDE autocomplete #13024

@github-actions

Description

@github-actions

Description

The Schema Consistency Analysis - 2026-01-31 identified that the main workflow schema's env field lacks examples, while the MCP config schema includes comprehensive examples. This reduces IDE discoverability and developer experience.

Current State

Main schema (pkg/parser/schemas/main_workflow_schema.json - $defs.stdio_mcp_tool.properties.env):

{
  "type": "object",
  "patternProperties": {
    "^[A-Z_][A-Z0-9_]*$": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "description": "Environment variables for MCP server"
}

MCP config schema has the same definition PLUS:

"examples": [
  {"GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}"},
  {"API_KEY": "${{ secrets.CUSTOM_API_KEY }}", "LOG_LEVEL": "debug"},
  {"BRAVE_API_KEY": "${{ secrets.BRAVE_API_KEY }}"}
]

Suggested Changes

Add the examples array from the MCP config schema to the main schema's env field definition (line ~450-460).

Files Affected

  • pkg/parser/schemas/main_workflow_schema.json (stdio_mcp_tool.properties.env)

Success Criteria

  • Examples array added to main schema env field
  • Examples match MCP config schema
  • Schema validation still passes
  • IDE autocomplete shows examples
  • Run make build to rebuild with embedded schema changes

Impact

High - Improves developer experience, IDE support, and reduces configuration errors

Effort

Low - ~1 hour (copy examples + test)

Source

Extracted from Schema Consistency Analysis discussion #13018

Priority

High - Quick win with significant DX improvement

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 15, 2026, 1:35 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions