-
Notifications
You must be signed in to change notification settings - Fork 49
Closed
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestplan
Description
Objective
Add inline examples to the MCP configuration schema, which currently has zero examples despite being one of the more complex configuration areas.
Context
This is Issue #8 (Medium) from the schema audit. While main_workflow_schema has 76 examples and included_file_schema has 3 examples, mcp_config_schema.json has 0 examples. This makes MCP server configuration harder to discover and use.
Approach
Add examples fields to key MCP configuration properties, focusing on common server types and configurations.
Files to Modify
pkg/parser/schemas/mcp_config_schema.json
Key Fields to Add Examples
-
Root MCP server configuration
"examples": [ {"stdio": {"command": "npx", "args": ["-y", "`@modelcontextprotocol/server-filesystem`", "/tmp"]}}, {"http": {"url": "(redacted), "headers": {"Authorization": "Bearer token"}}} ]
-
stdio configuration
"examples": [ {"command": "npx", "args": ["-y", "`@modelcontextprotocol/server-github`"]}, {"command": "docker", "args": ["run", "-i", "my-mcp-server"]} ]
-
http configuration
"examples": [ {"url": "(redacted), {"url": "(redacted), "headers": {"X-API-Key": "secret"}} ]
-
env configuration
"examples": [ {"GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}"}, {"API_KEY": "${{ secrets.CUSTOM_API_KEY }}", "LOG_LEVEL": "debug"} ]
Acceptance Criteria
- At least 4-5 key configuration areas have examples
- Examples cover both stdio and http MCP server types
- Examples demonstrate common patterns (npx, docker, headers, env)
- Examples are valid according to schema constraints
- Schema validation still passes
- Run
make buildto verify embedded schema compiles
Estimated Effort
30-45 minutes
AI generated by Plan Command for discussion #8130
Reactions are currently unavailable
Metadata
Metadata
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestplan