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

Aperta Adatta ai principianti
#178 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione Get Started collegata e individua la sezione “Remote MCP Servers with API Platform”. Verifica come la pagina descrive attualmente stdio e streamable HTTP (SSE), quindi aggiorna la precisazione in modo che sia esplicitamente indicato che i server MCP ospitati usano HTTP/SSE anziché stdio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
HTML
Stelle
2
Fork
64
Merge medio
1g 9h
PR unite (30g)
34

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di wso2/docs-api-platform

Tutte le issue di wso2/docs-api-platform

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.