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

Jump to bottom
Merged
merged 5 commits into from
Aug 28, 2025
Merged

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

merged 5 commits into from
Aug 28, 2025
+30 −12

Conversation

ronan-apollo
Copy link
Contributor

@ronan-apollo ronan-apollo commented Aug 7, 2025 •
edited
Loading

Update the transport type config table here - splitting it out into seperate tables per type to make the parent/child config clearer/simpler to parse

Before changes | After changes (preview)

@ronan-apollo ronan-apollo self-assigned this Aug 7, 2025
@ronan-apollo ronan-apollo requested review from a team as code owners August 7, 2025 15:44
@apollo-cla
Copy link

@ronan-apollo: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

@apollo-librarian
Copy link

apollo-librarian bot commented Aug 7, 2025 •
edited
Loading

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 6 changed, 2 removed 
* (developer-tools)/apollo-mcp-server/(latest)/best-practices.mdx
* (developer-tools)/apollo-mcp-server/(latest)/command-reference.mdx
* (developer-tools)/apollo-mcp-server/(latest)/limitations.mdx
* (developer-tools)/apollo-mcp-server/(latest)/quickstart.mdx
* (developer-tools)/apollo-mcp-server/(latest)/guides/index.mdx
* (developer-tools)/apollo-mcp-server/(latest)/_sidebar.yaml
- (developer-tools)/apollo-mcp-server/(latest)/install.mdx
- (developer-tools)/apollo-mcp-server/(latest)/guides/auth.mdx

Build ID: 4262bf242cc7d0742279ced4
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/4262bf242cc7d0742279ced4

nicholascioli
nicholascioli previously requested changes Aug 7, 2025
View reviewed changes
Copy link
Contributor

@nicholascioli nicholascioli left a comment

Choose a reason for hiding this comment

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

Looks great! Left a small note on fixing formatting.

docs/source/command-reference.mdx Outdated
Comment on lines 257 to 269
| 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 |
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you fix the formatting here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nicholascioli I pushed some tweaks, im not sure if I addressed this - what formatting specifics?

@mabuyo
Copy link
Contributor

mabuyo commented Aug 7, 2025

@ronan-apollo mind if we land these after the 0.7.0 PR? alternatively, you could rebase on top of that branch to align with the change in this docs page

@ronan-apollo
adjust transport table formatting
76fcda2 
Signed-off-by: Ronan Flynn-Curran <[email protected]>
@ronan-apollo
Copy link
Contributor Author

@ronan-apollo mind if we land these after the 0.7.0 PR? alternatively, you could rebase on top of that branch to align with the change in this docs page

no problem

DaleSeo
DaleSeo reviewed Aug 7, 2025
View reviewed changes
docs/source/command-reference.mdx Outdated
| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- |
| `type` | `"stdio"` | \* | 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

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

mabuyo
mabuyo reviewed Aug 8, 2025
View reviewed changes
docs/source/command-reference.mdx Outdated

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

##### STDIO (default)
Copy link
Contributor

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

docs/source/command-reference.mdx Outdated
| :-------- | :------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------- |
| `type` | `"stdio"` | \* | Use standard IO for communication between the server and client |

##### SSE
Copy link
Contributor

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

docs/source/command-reference.mdx Outdated
| `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

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

@ronan-apollo ronan-apollo requested a review from mabuyo August 19, 2025 04:27
@ronan-apollo
Copy link
Contributor Author

Suggestions applied! Thx

@DaleSeo DaleSeo requested a review from nicholascioli August 19, 2025 13:48
@DaleSeo DaleSeo enabled auto-merge August 28, 2025 12:50
@DaleSeo DaleSeo dismissed nicholascioli’s stale review August 28, 2025 12:52

feedback addressed

@DaleSeo DaleSeo merged commit cc9bc3d into main Aug 28, 2025
7 checks passed
@DaleSeo DaleSeo deleted the transport-docs-table branch August 28, 2025 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DaleSeo DaleSeo DaleSeo approved these changes

@mabuyo mabuyo Awaiting requested review from mabuyo

@nicholascioli nicholascioli Awaiting requested review from nicholascioli

Assignees

@ronan-apollo ronan-apollo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ronan-apollo @apollo-cla @mabuyo @nicholascioli @DaleSeo