Skip to content

Add $comment validation documentation to stdio_mcp_tool in included schema#8813

Merged
pelikhan merged 2 commits intomainfrom
copilot/add-validation-documentation-stdio-mcp-tool
Jan 4, 2026
Merged

Add $comment validation documentation to stdio_mcp_tool in included schema#8813
pelikhan merged 2 commits intomainfrom
copilot/add-validation-documentation-stdio-mcp-tool

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 4, 2026

The stdio_mcp_tool definition in included_file_schema.json was missing validation constraint documentation present in main_workflow_schema.json, creating inconsistent developer experience across schema files.

Changes

Added $comment fields to stdio_mcp_tool definition in pkg/parser/schemas/included_file_schema.json:

  • command property: Documents mutual exclusion with container
  • container property: Documents mutual exclusion with command
  • network property: Documents dependency on container (network only applies to container-based servers)
  • stdio_mcp_tool root: Comprehensive validation constraints explaining:
    1. Mutual exclusion between command and container
    2. Requirement for either command or container
    3. Network dependency on container
    4. Type constraints for stdio/local modes

Example

The added documentation clarifies validation behavior:

mcp-servers:
  example:
    type: stdio
    command: node server.js    # ✓ Valid
    # container: node:20       # ✗ Cannot specify both command and container
    
  container-based:
    type: stdio
    container: myorg/mcp-server
    network:                   # ✓ Network requires container
      allowed: [api.example.com]

Schema size increased by 824 bytes. Binary rebuild required due to //go:embed schema embedding.

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Add validation documentation to stdio_mcp_tool in included schema</issue_title>
<issue_description>## Objective

Add the missing $comment field to stdio_mcp_tool definition in included_file_schema.json to match the documentation in main_workflow_schema.json.

Context

The main schema includes 780 bytes of validation constraint documentation in the stdio_mcp_tool.$comment field that explains:

  • Mutual exclusion between command and container
  • Requirement for either command or container
  • Dependency of network on container
  • Type constraints for stdio/local modes

This documentation is missing from the included schema, creating inconsistent developer experience.

Approach

  1. Open pkg/parser/schemas/main_workflow_schema.json
  2. Copy the $comment field from $defs.stdio_mcp_tool
  3. Open pkg/parser/schemas/included_file_schema.json
  4. Add the same $comment field to $defs.stdio_mcp_tool
  5. Verify JSON formatting is valid

Files to Modify

  • pkg/parser/schemas/included_file_schema.json - Add $comment to stdio_mcp_tool

Acceptance Criteria

AI generated by Plan Command for discussion #8801

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.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add validation documentation for stdio_mcp_tool schema Add $comment validation documentation to stdio_mcp_tool in included schema Jan 4, 2026
Copilot AI requested a review from mnkiefer January 4, 2026 01:35
@pelikhan pelikhan marked this pull request as ready for review January 4, 2026 01:49
@pelikhan pelikhan merged commit a465c6d into main Jan 4, 2026
4 checks passed
@pelikhan pelikhan deleted the copilot/add-validation-documentation-stdio-mcp-tool branch January 4, 2026 01:49
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] Add validation documentation to stdio_mcp_tool in included schema

3 participants