Skip to content

Clarify supported MCP transport protocol for hosted API Platform servers #180

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

Open
Rami2212 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Clarify supported MCP transport protocol for hosted API Platform servers #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b65286c
Update MCP documentation on transport mechanisms
Rami2212 Apr 21, 2026
3b198ce
Update en/docs/mcp-servers/get-started-with-mcp.md
Rami2212 Apr 22, 2026
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
12 changes: 12 additions & 0 deletions en/docs/mcp-servers/get-started-with-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,22 @@ MCP is a JSON-RPC–based protocol designed to standardize how applications inte

MCP follows a host–client–server architecture and supports two primary transport mechanisms: stdio and streamable HTTP. While stdio is commonly used for local communication between clients and servers on the same machine, streamable HTTP is increasingly preferred for remote connections, especially as MCP adoption grows across networked environments.

> **Note:**
> The Model Context Protocol defines both `stdio` and streamable HTTP transports.
> - `stdio` is designed for **local, process-level communication** (for example, between a CLI/IDE and a locally running MCP server).
> - Streamable HTTP (SSE) is designed for **remote, network-based communication**.
Comment on lines +9 to +12

Copilot AI Apr 21, 2026

Copy link

Choose a reason for hiding this comment

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

This page uses a plain Markdown blockquote for the note, but most docs in this repo use MkDocs-style admonitions (e.g., !!! note in en/docs/api-platform-gateway/getting-started.md:5). Consider switching this to an admonition for consistent rendering/styling across the site.

Copilot uses AI. Check for mistakes.
>
> **MCP servers deployed on the WSO2 API Platform are hosted and accessed over the network. Therefore, only streamable HTTP (SSE) transport is supported.**
> MCP clients connecting to API Platform must be configured to use streamable HTTP (SSE), not `stdio`.

For more information, refer to the official [specification](https://modelcontextprotocol.io/introduction).

## Remote MCP Servers with API Platform

> **Transport Requirement:**
> Since API Platform exposes MCP servers as **remote, network-accessible endpoints**, it **does not support `stdio` transport**.
> All MCP interactions with API Platform must use **streamable HTTP (SSE)**.
Comment on lines +21 to +23

Copilot AI Apr 21, 2026

Copy link

Choose a reason for hiding this comment

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

This "Transport Requirement" callout is also formatted as a blockquote; for consistency with the rest of the docs (which use !!! note/!!! important admonitions), consider converting this to an admonition block so it renders consistently.

Copilot uses AI. Check for mistakes.

API Platform now includes support for MCP servers. It provides a complete solution for transforming existing APIs into intelligent, AI-ready tools. With a centralized control plane, API Platform simplifies the entire lifecycle of MCP server management—from creation to discovery—delivering a seamless experience for both API developers and AI agent builders. Additionally, API Platform allows you to customize the developer portal to deliver a tailored, MCP-only experience for your consumers.

![MCP Inspector](../assets/img/introduction/mcp/mcp-architecture.png)
Expand Down