Skip to content

Commit 843783a

Browse files
domdomeggclaude
andauthored
docs: make streamable-http the primary transport in examples (#602)
## Summary Changes `streamable-http` to be the recommended and primary transport type in documentation examples, while keeping SSE as a secondary option during the preview period. ## Changes - ✅ Update all primary remote server examples to use `streamable-http` - ✅ Reorder multi-transport examples to show `streamable-http` first - ✅ Add note that SSE is deprecated but still supported during preview - ✅ Update transport protocol requirements text to indicate `streamable-http` (recommended) and `sse` (deprecated) ## Context As noted in issue #487, the docs were using SSE as the primary example despite it being deprecated in the MCP specification (2025-06-18) in favor of streamable HTTP. This PR aligns the documentation with the spec while maintaining backward compatibility information for the preview period. Per maintainer feedback on the issue: - SSE is still supported during the preview phase - Eventually SSE support will be removed - The community would benefit from consistent messaging about the preferred transport ## Files Changed - `docs/guides/publishing/publish-server.md` - Main publishing guide - `docs/reference/server-json/generic-server-json.md` - Reference documentation with examples ## Approach This takes a balanced approach: - Makes streamable-http the clear primary/recommended option - Keeps SSE documented as supported during preview (not hidden) - Adds explicit note about deprecation status - Minimal changes, focused on examples and ordering Fixes #487 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent b04b013 commit 843783a

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

docs/guides/publishing/publish-server.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ Add the `remotes` field to your `server.json` (can coexist with `packages`):
371371
### Requirements
372372

373373
- **Service endpoint**: Your MCP server must be accessible at the specified URL
374-
- **Transport protocol**: Choose from `sse` (Server-Sent Events) or `streamable-http`
374+
- **Transport protocol**: Choose from `streamable-http` (recommended) or `sse` (deprecated)
375375
- **URL validation**: For domain namespaces only (see URL requirements below)
376376

377377
### Example server.json
@@ -384,8 +384,8 @@ Add the `remotes` field to your `server.json` (can coexist with `packages`):
384384
"version": "2.0.0",
385385
"remotes": [
386386
{
387-
"type": "sse",
388-
"url": "https://mcp.yourcompany.com/sse"
387+
"type": "streamable-http",
388+
"url": "https://mcp.yourcompany.com/http"
389389
}
390390
]
391391
}
@@ -399,12 +399,12 @@ You can offer multiple connection methods:
399399
{
400400
"remotes": [
401401
{
402-
"type": "sse",
403-
"url": "https://mcp.yourcompany.com/sse"
402+
"type": "streamable-http",
403+
"url": "https://mcp.yourcompany.com/http"
404404
},
405405
{
406-
"type": "streamable-http",
407-
"url": "https://mcp.yourcompany.com/http"
406+
"type": "sse",
407+
"url": "https://mcp.yourcompany.com/sse"
408408
}
409409
]
410410
}
@@ -423,11 +423,11 @@ Configure headers that clients should send when connecting:
423423
{
424424
"remotes": [
425425
{
426-
"type": "sse",
427-
"url": "https://mcp.yourcompany.com/sse",
426+
"type": "streamable-http",
427+
"url": "https://mcp.yourcompany.com/http",
428428
"headers": [
429429
{
430-
"name": "X-API-Key",
430+
"name": "X-API-Key",
431431
"description": "API key for authentication",
432432
"isRequired": true,
433433
"isSecret": true

docs/reference/server-json/generic-server-json.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -260,8 +260,8 @@ This will essentially instruct the MCP client to execute `dnx Knapcode.SampleMcp
260260
"version": "2.0.0",
261261
"remotes": [
262262
{
263-
"type": "sse",
264-
"url": "http://mcp-fs.anonymous.modelcontextprotocol.io/sse"
263+
"type": "streamable-http",
264+
"url": "http://mcp-fs.anonymous.modelcontextprotocol.io/http"
265265
}
266266
],
267267
"_meta": {
@@ -531,8 +531,8 @@ The `dnx` tool ships with the .NET 10 SDK, starting with Preview 6.
531531
],
532532
"remotes": [
533533
{
534-
"type": "sse",
535-
"url": "https://mcp.anonymous.modelcontextprotocol.io/sse",
534+
"type": "streamable-http",
535+
"url": "https://mcp.anonymous.modelcontextprotocol.io/http",
536536
"headers": [
537537
{
538538
"name": "X-API-Key",
@@ -553,8 +553,8 @@ The `dnx` tool ships with the .NET 10 SDK, starting with Preview 6.
553553
]
554554
},
555555
{
556-
"type": "streamable-http",
557-
"url": "https://mcp.anonymous.modelcontextprotocol.io/http"
556+
"type": "sse",
557+
"url": "https://mcp.anonymous.modelcontextprotocol.io/sse"
558558
}
559559
],
560560
"_meta": {

0 commit comments

Comments
 (0)