Skip to content

docs: clarify transport support in README overview#49

Merged
hrntknr merged 1 commit intomainfrom
docs/clarify-transport-support
Aug 20, 2025
Merged

docs: clarify transport support in README overview#49
hrntknr merged 1 commit intomainfrom
docs/clarify-transport-support

Conversation

@hrntknr
Copy link
Copy Markdown
Member

@hrntknr hrntknr commented Aug 20, 2025

Summary

Update README to clarify that the proxy supports all MCP transports (stdio, SSE, HTTP) with appropriate handling for each. This improves clarity about the proxy's transport capabilities.

Type of Change

  • docs: Documentation only changes

Related Issues

Update README to clarify that the proxy supports all MCP transports (stdio, SSE, HTTP) with appropriate handling for each.
Copilot AI review requested due to automatic review settings August 20, 2025 18:03
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Updates the README documentation to clarify the proxy's transport support capabilities. The changes improve clarity about how the proxy handles different MCP transport protocols (stdio, SSE, HTTP) and what transformations occur for each.

  • Clarified that all three MCP transport types (stdio, SSE, HTTP) are supported
  • Explained how stdio traffic is converted to /mcp endpoint while SSE/HTTP are proxied as-is
  • Updated terminology from "streamable HTTP" to simply "HTTP" for consistency

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@hrntknr hrntknr merged commit c09344c into main Aug 20, 2025
6 checks passed
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants