Skip to content

Commit 9f1b3e6

Browse files
sjnimsclaude
andauthored
docs(mcp-integration): add WebSocket server example (#71)
## Description Add missing `ws-server.json` example file to the mcp-integration skill's examples directory, completing coverage of all 4 MCP server types documented in SKILL.md. ## Type of Change - [x] Documentation update (improvements to README, CLAUDE.md, or component docs) ## Component(s) Affected - [x] Skills (methodology and best practices) ## Motivation and Context The mcp-integration skill documents 4 MCP server types (stdio, SSE, HTTP, WebSocket) in SKILL.md, but the `examples/` directory only contained 3 example files. This creates a completeness gap where users looking for a WebSocket example must extract it from the SKILL.md body rather than having a dedicated, well-commented example file. Fixes #70 ## How Has This Been Tested? **Test Configuration**: - Claude Code version: 1.0.32 - GitHub CLI version: 2.74.1 - OS: macOS **Test Steps**: 1. Verified new JSON file is valid JSON 2. Ran `markdownlint` on SKILL.md - no errors 3. Confirmed example follows same pattern as existing examples ## Checklist ### General - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings or errors ### Documentation - [x] I have updated the documentation accordingly (README.md, CLAUDE.md, or component docs) - [x] I have verified all links work correctly ### Markdown - [x] I have run `markdownlint` and fixed all issues - [x] My markdown follows the repository style (ATX headers, dash lists, fenced code blocks) ### Component-Specific Checks #### Skills (if applicable) - [x] Description uses third-person with specific trigger phrases - [x] SKILL.md is under 2,000 words (progressive disclosure) - [x] Detailed content is in `references/` subdirectory - [x] Templates follow the established format ## Additional Notes The new `ws-server.json` includes three example configurations to match the depth of existing examples: - `realtime-service` - Basic WebSocket with Bearer token auth - `streaming-data` - WebSocket with API key and client ID headers - `live-updates` - WebSocket with custom connection headers --- 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent d3291b8 commit 9f1b3e6

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

plugins/plugin-dev/skills/mcp-integration/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,7 @@ Working examples in `examples/`:
528528
- **`stdio-server.json`** - Local stdio MCP server
529529
- **`sse-server.json`** - Hosted SSE server with OAuth
530530
- **`http-server.json`** - REST API with token auth
531+
- **`ws-server.json`** - WebSocket server for real-time communication
531532

532533
### External Resources
533534

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"_comment": "Example WebSocket MCP server configuration for real-time bidirectional communication",
3+
"realtime-service": {
4+
"type": "ws",
5+
"url": "wss://mcp.example.com/ws",
6+
"headers": {
7+
"Authorization": "Bearer ${TOKEN}"
8+
}
9+
},
10+
"streaming-data": {
11+
"type": "ws",
12+
"url": "wss://stream.example.com/mcp",
13+
"headers": {
14+
"X-API-Key": "${API_KEY}",
15+
"X-Client-ID": "${CLIENT_ID}"
16+
}
17+
},
18+
"live-updates": {
19+
"type": "ws",
20+
"url": "wss://live.example.com/mcp/v1",
21+
"headers": {
22+
"Authorization": "Bearer ${WS_TOKEN}",
23+
"X-Connection-Type": "persistent"
24+
}
25+
}
26+
}

0 commit comments

Comments
 (0)