Skip to content

docs(mcp-integration): add WebSocket server example#71

Merged
sjnims merged 1 commit intomainfrom
docs/70-add-websocket-example
Dec 9, 2025
Merged

docs(mcp-integration): add WebSocket server example#71
sjnims merged 1 commit intomainfrom
docs/70-add-websocket-example

Conversation

@sjnims
Copy link
Copy Markdown
Owner

@sjnims sjnims commented Dec 9, 2025

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

  • Documentation update (improvements to README, CLAUDE.md, or component docs)

Component(s) Affected

  • 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

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings or errors

Documentation

  • I have updated the documentation accordingly (README.md, CLAUDE.md, or component docs)
  • I have verified all links work correctly

Markdown

  • I have run markdownlint and fixed all issues
  • My markdown follows the repository style (ATX headers, dash lists, fenced code blocks)

Component-Specific Checks

Skills (if applicable)

  • Description uses third-person with specific trigger phrases
  • SKILL.md is under 2,000 words (progressive disclosure)
  • Detailed content is in references/ subdirectory
  • 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

Add missing ws-server.json example file to complete coverage of all 4
MCP server types documented in SKILL.md. Includes three example
configurations demonstrating various WebSocket use cases with headers.

Fixes #70

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Dec 9, 2025

Claude finished @sjnims's task —— View job


PR Review: WebSocket Server Example

Summary

Looks good - This is a clean, well-structured documentation update that completes the MCP server example coverage.

What's Good

  1. Completeness: Fills the documented gap by adding the 4th example file to match all server types in SKILL.md (stdio, SSE, HTTP, WebSocket).

  2. Consistent Pattern: The new ws-server.json follows the exact same structure as existing examples:

    • Top-level _comment field explaining purpose ✅
    • Three example configurations showing different use cases ✅
    • Demonstrates various header patterns (Bearer token, API keys, custom headers) ✅
    • Uses environment variable substitution (${TOKEN}, ${API_KEY}, etc.) ✅
  3. Markdown Quality:

    • markdownlint passes with no errors
    • ✅ Single line addition to SKILL.md follows existing list format
    • ✅ Uses dash-style list item
  4. JSON Validity:

    • ✅ Valid JSON syntax confirmed
    • ✅ Proper structure with type, url, and headers fields
  5. Documentation Alignment: The examples in ws-server.json align perfectly with the WebSocket section in SKILL.md (lines 143-164), showing:

    • Basic Bearer token auth (realtime-service)
    • Multiple custom headers (streaming-data)
    • Complex header combinations (live-updates)

Pattern Comparison

Verified against existing examples:

File Examples Pattern Match
stdio-server.json 3 configs ✅ Top comment + 3 examples
sse-server.json 3 configs ✅ Top comment + 3 examples
http-server.json 2 configs ⚠️ Only 2 examples
ws-server.json 3 configs ✅ Top comment + 3 examples

Note: The new file actually provides MORE examples than http-server.json, showing good coverage.

Checklist Verification

General

  • ✅ Follows style guidelines (consistent with existing examples)
  • ✅ Self-review evident (well-structured examples)
  • ✅ No new warnings or errors

Documentation

  • ✅ Updated SKILL.md to reference new example file
  • ✅ All paths are valid (verified file exists)

Markdown

  • markdownlint passes with zero errors
  • ✅ Follows repository style (dash lists, proper formatting)

Skills Component

  • ✅ Progressive disclosure maintained (example in examples/, not inline)
  • ✅ Follows established template format

Minor Observations

No issues found. The PR:


Recommendation: Approve and merge ✅

@sjnims sjnims self-assigned this Dec 9, 2025
@claude claude bot added documentation Improvements or additions to documentation component:skill Skills layer effort:small < 1 hour labels Dec 9, 2025
@sjnims sjnims merged commit 9f1b3e6 into main Dec 9, 2025
8 checks passed
@sjnims sjnims deleted the docs/70-add-websocket-example branch December 9, 2025 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:skill Skills layer documentation Improvements or additions to documentation effort:small < 1 hour

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Add WebSocket (ws) example to mcp-integration skill

1 participant