From ee5bb4dd32a7131a7abbaffe4768f3a3880cbd5a Mon Sep 17 00:00:00 2001 From: Ronan Flynn-Curran Date: Tue, 5 Aug 2025 08:40:57 -0700 Subject: [PATCH 1/5] breakout the transport config into their own sections --- docs/source/command-reference.mdx | 42 ++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/docs/source/command-reference.mdx b/docs/source/command-reference.mdx index fe9735d1..5d6891e2 100644 --- a/docs/source/command-reference.mdx +++ b/docs/source/command-reference.mdx @@ -237,18 +237,36 @@ The default value for `source` is `"uplink"`. #### Transport configuration -These fields are under the top-level `transport` key. The available fields depend on the value of the nested `type` key. -The default value for `type` is `"stdio"`. - -| Type | Option | Type | Default | Description | -| :------------- | :-------- | :------------------ | :---------- | :---------------------------------------------------------------------------------------------------------------------------- | -| stdio | `type` | `"stdio"` | \* | Use standard IO for communication between the server and client | -| SSE | `type` | `"sse"` | | Host the MCP server on the supplied configuration, using SSE for communication. Note: Deprecated in favor of `StreamableHTTP` | -| SSE | `address` | `IpAddr` | `127.0.0.1` | The IP address to bind to | -| SSE | `port` | `u16` | `5000` | The port to bind to | -| StreamableHTTP | `type` | `"streamable_http"` | | Host the MCP server on the configuration, using streamable HTTP messages. | -| StreamableHTTP | `address` | `IpAddr` | `127.0.0.1` | The IP address to bind to | -| StreamableHTTP | `port` | `u16` | `5000` | The port to bind to | +These fields are under the top-level transport key, to configure running the MCP Server in different environments - `STDIO`, `SSE` or `StreamableHTTP`. + +``` +transport: + type: stdio +``` + +The available fields depend on the value of the nested `type` key: + +### STDIO (default) + +| Option | Value | Default Value | Description | +| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | +| `type` | `"stdio"` | \* | Use standard IO for communication between the server and client | + +### SSE + +| Option | Value | Value Type | Description | +| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | +| `type` | `"sse"` | | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of `StreamableHTTP` | +| `address` | `127.0.0.1 (default)` | `IpAddr` | The IP address to bind to | +| `port` | `5000 (default)` | `u16` | The port to bind to | + +### StreamableHTTP + +| Option | Value | Value Type | Description | +| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | +| `type` | `"streamable_http"` | | Host the MCP server on the configuration, using streamable HTTP messages. | +| `address` | `127.0.0.1 (default)` | `IpAddr` | The IP address to bind to | +| `port` | `5000 (default)` | `u16` | The port to bind to | ### Mapping rover dev options From 76fcda202f52df7e4620bb2f876467c05522d5cf Mon Sep 17 00:00:00 2001 From: Ronan Flynn-Curran Date: Thu, 7 Aug 2025 12:32:00 -0700 Subject: [PATCH 2/5] adjust transport table formatting Signed-off-by: Ronan Flynn-Curran --- docs/source/command-reference.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/command-reference.mdx b/docs/source/command-reference.mdx index 5d6891e2..c70a60e7 100644 --- a/docs/source/command-reference.mdx +++ b/docs/source/command-reference.mdx @@ -246,27 +246,27 @@ transport: The available fields depend on the value of the nested `type` key: -### STDIO (default) +##### STDIO (default) | Option | Value | Default Value | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | | `type` | `"stdio"` | \* | Use standard IO for communication between the server and client | -### SSE +##### SSE | Option | Value | Value Type | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | | `type` | `"sse"` | | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of `StreamableHTTP` | -| `address` | `127.0.0.1 (default)` | `IpAddr` | The IP address to bind to | -| `port` | `5000 (default)` | `u16` | The port to bind to | +| `address` | `127.0.0.1` (default) | `IpAddr` | The IP address to bind to | +| `port` | `5000` (default) | `u16` | The port to bind to | -### StreamableHTTP +##### StreamableHTTP | Option | Value | Value Type | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | | `type` | `"streamable_http"` | | Host the MCP server on the configuration, using streamable HTTP messages. | -| `address` | `127.0.0.1 (default)` | `IpAddr` | The IP address to bind to | -| `port` | `5000 (default)` | `u16` | The port to bind to | +| `address` | `127.0.0.1` (default) | `IpAddr` | The IP address to bind to | +| `port` | `5000` (default) | `u16` | The port to bind to | ### Mapping rover dev options From 72522f28afdb688a301007cfff68162dbdab93ab Mon Sep 17 00:00:00 2001 From: Ronan Flynn-Curran Date: Mon, 18 Aug 2025 21:19:02 -0700 Subject: [PATCH 3/5] add note about SSE transport deprication Signed-off-by: Ronan Flynn-Curran --- docs/source/command-reference.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/command-reference.mdx b/docs/source/command-reference.mdx index c70a60e7..7fa3a8f8 100644 --- a/docs/source/command-reference.mdx +++ b/docs/source/command-reference.mdx @@ -252,19 +252,19 @@ The available fields depend on the value of the nested `type` key: | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | | `type` | `"stdio"` | \* | Use standard IO for communication between the server and client | -##### SSE +##### StreamableHTTP | Option | Value | Value Type | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | -| `type` | `"sse"` | | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of `StreamableHTTP` | +| `type` | `"streamable_http"` | | Host the MCP server on the configuration, using streamable HTTP messages. | | `address` | `127.0.0.1` (default) | `IpAddr` | The IP address to bind to | | `port` | `5000` (default) | `u16` | The port to bind to | -##### StreamableHTTP +##### SSE (Depricated, use StreamableHTTP) | Option | Value | Value Type | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | -| `type` | `"streamable_http"` | | Host the MCP server on the configuration, using streamable HTTP messages. | +| `type` | `"sse"` | | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of `StreamableHTTP` | | `address` | `127.0.0.1` (default) | `IpAddr` | The IP address to bind to | | `port` | `5000` (default) | `u16` | The port to bind to | From ad98a383e20b906d8b362c0b225e314c9b87676d Mon Sep 17 00:00:00 2001 From: ronan Date: Mon, 18 Aug 2025 21:23:08 -0700 Subject: [PATCH 4/5] Update docs/source/command-reference.mdx Co-authored-by: Michelle Mabuyo --- docs/source/command-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/command-reference.mdx b/docs/source/command-reference.mdx index 7fa3a8f8..4677aa8f 100644 --- a/docs/source/command-reference.mdx +++ b/docs/source/command-reference.mdx @@ -237,7 +237,7 @@ The default value for `source` is `"uplink"`. #### Transport configuration -These fields are under the top-level transport key, to configure running the MCP Server in different environments - `STDIO`, `SSE` or `StreamableHTTP`. +These fields are under the top-level `transport` key and configure the MCP Server to run in different environments: stdio, Streamable HTTP, or SSE (deprecated). ``` transport: From 9b7861df2718d20131bf2aa8db4e45f058529556 Mon Sep 17 00:00:00 2001 From: Ronan Flynn-Curran Date: Mon, 18 Aug 2025 21:26:37 -0700 Subject: [PATCH 5/5] feedback about transport casing and formatting Signed-off-by: Ronan Flynn-Curran --- docs/source/command-reference.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/command-reference.mdx b/docs/source/command-reference.mdx index 4677aa8f..833e0f98 100644 --- a/docs/source/command-reference.mdx +++ b/docs/source/command-reference.mdx @@ -237,7 +237,7 @@ The default value for `source` is `"uplink"`. #### Transport configuration -These fields are under the top-level `transport` key and configure the MCP Server to run in different environments: stdio, Streamable HTTP, or SSE (deprecated). +These fields are under the top-level `transport` key, to configure running the MCP Server in different environments - stdio, Streamable HTTP or SSE (deprecated). ``` transport: @@ -246,13 +246,13 @@ transport: The available fields depend on the value of the nested `type` key: -##### STDIO (default) +##### stdio (default) | Option | Value | Default Value | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | | `type` | `"stdio"` | \* | Use standard IO for communication between the server and client | -##### StreamableHTTP +##### Streamable HTTP | Option | Value | Value Type | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- | @@ -260,7 +260,7 @@ The available fields depend on the value of the nested `type` key: | `address` | `127.0.0.1` (default) | `IpAddr` | The IP address to bind to | | `port` | `5000` (default) | `u16` | The port to bind to | -##### SSE (Depricated, use StreamableHTTP) +##### SSE (Deprecated, use StreamableHTTP) | Option | Value | Value Type | Description | | :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- |