docs: add Docker MCP Gateway streaming transport documentation #6558
Conversation
- Created comprehensive documentation for Docker MCP Gateway streaming transport configuration - Clarified that the /mcp path is required when using streaming transport mode - Added reference in main README.md to guide users to the new documentation - Addresses issue #6557 where users were experiencing connection errors due to missing /mcp path
dosubot
bot
added
size:M
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
| When configuring your MCP client to connect to a Docker MCP Gateway running with streaming transport, you must include the `/mcp` path in the URL: | ||
|
|
||
| ```json | ||
| { |
There was a problem hiding this comment.
The JSON examples use tabs for indentation, which is inconsistent with typical JSON formatting standards. Consider using 2 or 4 spaces instead:
|
|
||
| ## Additional Notes | ||
|
|
||
| - This requirement is specific to the `streaming` transport mode |
There was a problem hiding this comment.
Is this path requirement specific only to the streaming transport? It would be helpful to clarify whether other transport modes have different requirements or if this applies universally.
|
|
||
| ## Quick Reference | ||
|
|
||
| | Transport Type | Correct URL Format | |
There was a problem hiding this comment.
The quick reference table only shows the streaming transport. Consider either:
- Adding other transport types with their URL formats, or
- Explicitly stating that this requirement is unique to streaming transport
This would make the documentation more comprehensive.
| ## Related Links | ||
|
|
||
| - [MCP Documentation](https://docs.roocode.com/advanced-usage/mcp) | ||
| - [Docker MCP Toolkit Documentation](https://docs.roocode.com/advanced-usage/mcp#docker-mcp-toolkit) |
There was a problem hiding this comment.
Consider adding a troubleshooting section with common error messages users might encounter (like "Invalid session ID") and their solutions. This would help users debug issues more effectively.
|
|
||
| ## Issue | ||
|
|
||
| When connecting an MCP client to the Docker MCP Gateway using the `streaming` transport (`docker mcp gateway run --transport streaming`), the connection will fail with errors like "Invalid session ID" if the client is configured to connect to the root URL (e.g., `http://localhost:8080`). |
There was a problem hiding this comment.
The document mentions but doesn't show a complete example. Would it be helpful to add a full command example with all necessary parameters for starting the gateway?
hannesrudolph
added
the
Issue/PR - Triage
|
This is related to the marketplace, closing |
This PR addresses issue #6557 by adding comprehensive documentation for Docker MCP Gateway streaming transport configuration.
Summary of Changes
Created
docs/docker-mcp-gateway-streaming.mdwith detailed documentation explaining:/mcppath in the URL)Updated
README.mdto include a reference to the new documentation in the MCP sectionProblem Solved
Users were experiencing "Invalid session ID" errors when trying to connect to Docker MCP Gateway using the streaming transport because they were using the root URL (e.g.,
http://localhost:8080) instead of the required/mcpendpoint (e.g.,http://localhost:8080/mcp).This documentation clarifies the correct URL format and helps prevent future confusion.
Fixes #6557
Important
Adds documentation for Docker MCP Gateway streaming transport configuration, addressing URL path issues.
docs/docker-mcp-gateway-streaming.mdwith detailed instructions on configuring Docker MCP Gateway with streaming transport./mcp, causing "Invalid session ID" errors.README.mdunder the MCP section to reference the new documentation for Docker MCP Gateway streaming transport.This description was created by
for 3985653. You can customize this summary. It will automatically update as commits are pushed.