Skip to content

[docs] breakout the transport config into their own sections #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 28, 2025
Merged

[docs] breakout the transport config into their own sections #231

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ee5bb4d
breakout the transport config into their own sections
Aug 5, 2025
76fcda2
adjust transport table formatting
ronan-apollo Aug 7, 2025
72522f2
add note about SSE transport deprication
ronan-apollo Aug 19, 2025
ad98a38
Update docs/source/command-reference.mdx
ronan-apollo Aug 19, 2025
9b7861d
feedback about transport casing and formatting
ronan-apollo Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions docs/source/command-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,18 +237,36 @@

#### 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`.

Check warning on line 240 in docs/source/command-reference.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L240 

This change improves clarity, uses code font for the `transport` key as required, and adds the Oxford comma to the list.

```suggestion
These fields are under the top-level <code>transport</code> key and configure the MCP Server to run in different environments: <code>STDIO</code>, <code>SSE</code>, or <code>StreamableHTTP</code>.
```

```
transport:
type: stdio
```
The available fields depend on the value of the nested `type` key:
##### STDIO (default)
Copy link
Contributor

@mabuyo mabuyo Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use lowercase here to match with the spec? stdio

| Option | Value | Default Value | Description |
| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- |
| `type` | `"stdio"` | \* | Use standard IO for communication between the server and client |

Check warning on line 253 in docs/source/command-reference.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L253 

String values should not be enclosed in quotes within code formatting.

```suggestion
| <code>type</code>    | <code>stdio</code>             | \*             | Use standard IO for communication between the server and client                                                          |
```
##### SSE
Copy link
Contributor

@DaleSeo DaleSeo Aug 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the SSE transport is still supported for now, it doesn't not receive new features and may be removed in a future release. How about we move the deprecation warning out of the table and add a note here that this transport is now deprecated and we recommend using Streamable HTTP instead? (see the spec here)

Copy link
Contributor

@mabuyo mabuyo Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

++ Let's move this down after Streamable HTTP and add "(Deprecated)" to the heading

| Option | Value | Value Type | Description |
| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- |
| `type` | `"sse"` | | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of `StreamableHTTP` |

Check warning on line 259 in docs/source/command-reference.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L259 

Use the present tense for descriptions. String values should not be enclosed in quotes within code formatting. End complete sentences with a period.

```suggestion
| <code>type</code>    | <code>sse</code>               |               | Hosts the MCP server on the supplied config, using SSE for communication. Deprecated in favor of <code>StreamableHTTP</code>.       |
```
| `address` | `127.0.0.1` (default) | `IpAddr` | The IP address to bind to |
| `port` | `5000` (default) | `u16` | The port to bind to |
##### StreamableHTTP
Copy link
Contributor

@mabuyo mabuyo Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
##### StreamableHTTP
##### Streamable HTTP

| Option | Value | Value Type | Description |
| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- |
| `type` | `"streamable_http"` | | Host the MCP server on the configuration, using streamable HTTP messages. |

Check warning on line 267 in docs/source/command-reference.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L267 

Use the present tense for descriptions. String values should not be enclosed in quotes within code formatting. End complete sentences with a period.

```suggestion
| <code>type</code>    | <code>streamable_http</code>   |               | Hosts 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
Expand Down