Skip to content

[plan] Clarify or deprecate "mode" property in main schema #11712

@github-actions

Description

@github-actions

Objective

Determine the purpose of the mode property in main schema and either document it clearly or deprecate it.

Context

From discussion #11706: The main schema defines both mode and type with identical enum values, but MCP config schema only has type. It's unclear if mode is:

  • An alias for type
  • A deprecated field
  • A workflow-specific property

Approach

  1. Search codebase for usage of mode field in MCP context
  2. Check if parser/compiler treats mode and type differently
  3. Review git history to understand when/why mode was added
  4. Either:
    • Document mode as an alias (if intentional)
    • Mark as deprecated with migration guide
    • Remove if unused

Files to Investigate

  • pkg/parser/mcp.go - Check parsing logic
  • pkg/workflow/mcp-config-*.go - Check compilation logic
  • .github/workflows/*.md - Check for usage in workflows
  • Git history of main_workflow_schema.json

Acceptance Criteria

  • Usage of mode vs type is clarified
  • Decision documented in schema description or comments
  • If deprecated: Add deprecation notice with migration path
  • If alias: Add clear documentation explaining relationship
  • If unused: Remove from schema
  • Update docs if needed

AI generated by Plan Command for discussion #11706

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions