-
Notifications
You must be signed in to change notification settings - Fork 2
Closed
Labels
component:skillSkills layerSkills layerdocumentationImprovements or additions to documentationImprovements or additions to documentationeffort:small< 1 hour< 1 hourgood first issueGood for newcomersGood for newcomerspriority:lowNice to haveNice to have
Description
Which documentation needs improvement?
Skill documentation
Specific Location
plugins/plugin-dev/skills/mcp-integration/examples/
What's unclear or missing?
The mcp-integration skill documents 4 MCP server types in SKILL.md:
- stdio ✓
- SSE ✓
- HTTP ✓
- WebSocket ✓
However, the examples/ directory only contains 3 example files:
stdio-server.json✓sse-server.json✓http-server.json✓ws-server.json✗ missing
This creates a completeness gap where users looking for a copy-paste WebSocket example must extract it from the SKILL.md body (around line 118) rather than having a dedicated, well-commented example file like the other server types.
Suggested Improvement
Add examples/ws-server.json following the same pattern as existing example files:
{
"_comment": "Example WebSocket MCP server configuration for real-time bidirectional communication",
"realtime-service": {
"type": "ws",
"url": "wss://mcp.example.com/ws",
"headers": {
"Authorization": "Bearer ${TOKEN}"
}
},
"streaming-data": {
"type": "ws",
"url": "wss://stream.example.com/mcp",
"headers": {
"X-API-Key": "${API_KEY}",
"X-Client-ID": "${CLIENT_ID}"
}
}
}Also update the "Example Configurations" section in SKILL.md (around line 528) to include:
- **`ws-server.json`** - WebSocket server for real-time communicationType of issue
- Missing information
Additional Context
- Discovered during: Comprehensive skill review comparing SKILL.md content against
examples/directory - Priority: Low - the inline documentation in SKILL.md is sufficient, but adding the example improves completeness and consistency with other server types
- Measurements: SKILL.md has 1,663 words covering all 4 types; examples should match this coverage
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
component:skillSkills layerSkills layerdocumentationImprovements or additions to documentationImprovements or additions to documentationeffort:small< 1 hour< 1 hourgood first issueGood for newcomersGood for newcomerspriority:lowNice to haveNice to have