Doc Feedback: Clarification needed on supported MCP Transport Protocols (stdio vs. HTTP/SSE)

Open Beginner friendly
#178 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Start with the linked Get Started documentation and locate the “Remote MCP Servers with API Platform” section. Verify how the page currently describes stdio and streamable HTTP (SSE), then update the clarification so hosted MCP servers are explicitly identified as using HTTP/SSE rather than stdio.

Written by the indexing model from the issue text.

Description

Description:
The "Get Started" documentation for MCP Servers mentions both stdio and streamable HTTP as primary transport mechanisms for the protocol. However, the documentation does not explicitly distinguish which of these is supported by the WSO2 API Platform’s hosted environment.

Location:
https://wso2.com/bijira/docs/mcp-servers/get-started-with-mcp/

Technical Detail:
stdio transport is architecturally designed for local communication between a host (e.g., a local IDE or CLI) and a server running as a sub process on the same machine.
streamable HTTP (SSE) is the industry standard for remote/networked MCP connections.

Since WSO2 provides a cloud hosted/managed Gateway solution, supporting stdio as a transport for a remote client to connect to the WSO2 gateway is technically impossible. Listing stdio in the "Get Started" guide without clarifying that the WSO2 Platform implementation specifically uses HTTP/SSE creates theoretical ambiguity.

Impact:
Developers new to MCP might attempt to configure their clients using stdio transport for a WSO2 hosted server, leading to configuration errors. As an enterprise-grade platform, the documentation should clearly define the platform’s boundary supporting the protocol specification while adhering to the constraints of a networked gateway.

Suggested Fix:
Add a clarifying note in the "Remote MCP Servers with API Platform" section stating that while the MCP protocol supports stdio, the WSO2 API Platform exclusively utilizes the streamable HTTP (SSE) transport for its hosted MCP server implementations.

Dominant language
HTML
Stars
2
Forks
64
Avg merge
1d 9h
Merged PRs (30d)
34

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/docs-api-platform

All issues in wso2/docs-api-platform

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.