Clarify supported MCP transport protocol for hosted API Platform servers

[Rami2212]

Description

This PR updates the Get Started with MCP Servers documentation to clearly distinguish between the transport mechanisms defined by the Model Context Protocol and the transport mechanism supported by the WSO2 API Platform hosted environment.

The existing documentation mentions both stdio and streamable HTTP as primary MCP transport mechanisms, but does not explicitly clarify which transport is supported by the platform implementation. This may lead to confusion for developers attempting to configure remote MCP clients.

Since the API Platform exposes MCP servers as remote, network-accessible endpoints, the stdio transport is not applicable in this context because it is designed only for local process-level communication.

This update adds explicit notes to clarify that:

• stdio is intended for local communication between a client and a server running on the same machine
• API Platform hosted MCP servers support only streamable HTTP (SSE)
• Clients must use HTTP/SSE transport when connecting to MCP servers deployed on the platform

Changes Made

• Added a clarification note under the Overview section
• Added a transport requirement note under Remote MCP Servers with API Platform
• Explicitly documented that stdio is not supported for hosted MCP server connections
• Improved developer guidance to prevent transport misconfiguration

Problem Solved

This resolves ambiguity between:

• protocol-level supported transports
• platform-level implementation support

and improves onboarding clarity for developers new to MCP integrations.

Impact

This is a documentation-only change with no functional impact on the platform.

It improves:

• developer experience
• configuration accuracy
• architectural clarity

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 58c8810e-3bcd-48f5-b6d4-8403803e081a

📥 Commits

Reviewing files that changed from the base of the PR and between b65286c and 3b198ce.

📒 Files selected for processing (1)

• en/docs/mcp-servers/get-started-with-mcp.md

✅ Files skipped from review due to trivial changes (1)

• en/docs/mcp-servers/get-started-with-mcp.md

---

📝 Walkthrough

Summary

This documentation update clarifies the supported transport mechanism for MCP servers in the WSO2 API Platform hosted environment. It adds callouts to the "Get Started with MCP Servers" guide to state that platform-hosted MCP servers are network-accessible and therefore support only streamable HTTP (SSE); the stdio transport (for local process-level communication) is not supported for hosted servers.

Changes

• Modified en/docs/mcp-servers/get-started-with-mcp.md to add two callout notes:
  • Overview: Clarifies that hosted MCP servers support only streamable HTTP (SSE) and that stdio is not applicable for remote access.
  • Remote MCP Servers with API Platform: Reiterates that clients must use HTTP/SSE when connecting to API Platform–hosted MCP servers.

Impact

Improves developer guidance and prevents transport misconfiguration by distinguishing MCP protocol transports from the transport mechanisms supported by the hosted API Platform. No functional changes to the platform.

Walkthrough

This update adds documentation clarifications for MCP transport constraints when using WSO2 API Platform. Two callout notes were inserted specifying that MCP servers hosted on API Platform are accessed over the network and therefore only support streamable HTTP (SSE) transport, while stdio transport is unsupported. An additional transport requirement section was added under "Remote MCP Servers with API Platform" to reinforce that all MCP interactions with the platform must use streamable HTTP (SSE) and that clients must be configured accordingly.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title directly and clearly summarizes the main purpose of the PR: clarifying MCP transport protocol support for hosted API Platform servers, which aligns with the documentation changes made.
Description check	✅ Passed	The PR description is well-structured with clear Purpose, Goals, Approach, and Impact sections. However, it does not follow the repository's required template, missing sections like Release note, Documentation, Training, and Certification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[Copilot]

Pull request overview

This PR clarifies which MCP transport is supported when MCP servers are deployed/hosted on the WSO2 API Platform, to prevent users from attempting to use stdio with remote endpoints.

Changes:

• Added an overview note distinguishing MCP protocol transports (stdio vs streamable HTTP/SSE) vs platform support.
• Added a “Transport Requirement” note under the remote-hosted MCP servers section stating stdio is not supported and HTTP/SSE is required.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

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]

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.