Skip to content

Update MCP Server Documentation for Claude Code (SSE Deprecated, WebSocket Needed) #2

@charlieoliver

Description

@charlieoliver

Problem

The current reference/mcp-server.md strongly and exclusively documents Server-Sent Events (SSE)-based MCP endpoints (e.g., https://mcp.realestateapi.com/sse, https://developer.mcp.realestateapi.com/sse). However, Claude Code recently deprecated support for SSE-based MCP servers, now requiring WebSocket (WS) transport for MCP connections.

As a result, users following the documentation for integrating Real Estate API with Claude Code will not be able to connect successfully.

Proposed Solution

  • Add full guidance and configuration examples for connecting to the production and developer MCP servers using WebSocket (wss:) endpoints alongside SSE.
  • If WebSocket endpoints already exist:
    • Document their URLs, authentication options (esp. API key handling for WS), and configuration for Claude Code and other WS-only MCP clients.
  • If WebSocket endpoints do not exist:
    • Add a clear notice about current incompatibility with Claude Code and the planned timeline for WS support.
    • Optionally, reference or open a tracking issue in the relevant backend/server repo to add WS support to the MCP server.
  • Clearly indicate in the docs that SSE support is deprecated for Claude Code and may be deprecated in other clients soon; include a compatibility/deprecation matrix.
  • Show updated config file examples for MCP clients (including Claude Code), highlighting necessary changes for migration from SSE to WS.
  • Add migration notes so users can update their configuration files without confusion.

References

  • reference/mcp-server.md (last commit: 5f7cd85)
  • Claude Code release notes about SSE MCP deprecation (user may need to provide a link if required)

Impacted Sections

  • All configuration examples (Production & Developer MCP server config)
  • Compatibility section
  • Quick Start
  • Any references to Claude Code or other Anthropic-based clients

If more information or confirmation about your WS endpoints/formats is needed, please clarify. Happy to suggest concrete config snippets if you share endpoint details.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions