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 all 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, Streamable HTTP or SSE (deprecated).

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 

Improves sentence structure for clarity, adds the required Oxford comma, and applies code font to code symbols.

```suggestion
The fields under the top-level <code>transport</code> key configure how the MCP Server runs in different environments: <code>stdio</code>, Streamable HTTP, or <code>sse</code> (deprecated).
```

```
transport:
type: stdio
```

The available fields depend on the value of the nested `type` key:

##### stdio (default)

Check notice on line 249 in docs/source/command-reference.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L249 

Applies code font to a code symbol used as a heading.

```suggestion
##### <code>stdio</code> (default)
```

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

##### Streamable HTTP

| 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 |

##### SSE (Deprecated, use StreamableHTTP)

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

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L263 

Ensures consistent naming of "Streamable HTTP".

```suggestion
##### SSE (Deprecated, use Streamable HTTP)
```

| 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 267 in docs/source/command-reference.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/command-reference.mdx#L267 

The recommended replacement type is <code>streamable_http</code>. Also adds a period to the end of the sentence for grammatical correctness.

```suggestion
| <code>type</code>    | <code>"sse"</code>             |               | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of <code>streamable_http</code>. |
```
| `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
Loading