streamable http readme

Author: kevalmahajan

docs/docs/architecture/adr/003-expose-multi-transport-endpoints.md

@@ -23,6 +23,7 @@ The gateway will support the following built-in transports:
 - **HTTP JSON-RPC** (primary RPC interface)
 - **WebSocket** (bidirectional messaging)
 - **SSE (Server-Sent Events)** (for push-only event streaming)
+- **Streamable HTTP**  (bidirectional, resumable streams, efficient MCP transport over HTTP)
 - **STDIO** (optional local CLI / subprocess transport)
 
 Transport selection is dynamic, based on environment (`TRANSPORT_TYPE`) and route grouping. All transports share the same service layer and authentication mechanisms.

docs/docs/architecture/index.md

@@ -6,7 +6,7 @@ This gateway:
 
 - Wraps REST/MCP tools and resources under JSON-RPC and streaming protocols
 - Offers a pluggable backend (cache, auth, storage)
-- Exposes multiple transports (HTTP, WS, SSE, stdio)
+- Exposes multiple transports (HTTP, WS, SSE, StreamableHttp, stdio)
 - Automatically discovers and merges federated peers
 
 ## System Architecture

docs/docs/index.md

@@ -25,7 +25,7 @@ A flexible FastAPI-based gateway and router for **Model Context Protocol (MCP)**
 
 ## Key Features
 
-- **Multi-Transport**: HTTP, WebSocket, SSE, and stdio with auto-negotiation
+- **Multi-Transport**: HTTP, WebSocket, SSE, Streamable HTTP and stdio with auto-negotiation
 - **Federation & Health Checks**: Auto-discovery (mDNS or static), syncing, monitoring
 - **Admin UI**: Real-time management (HTMX + Tailwind)
 - **Tool Wrapping**: REST / CLI / local functions with JSON-Schema validation

docs/docs/overview/index.md

@@ -15,7 +15,7 @@ This section introduces what the Gateway is, how it fits into the MCP ecosystem,
 - Protocol enforcement, health monitoring, and registry centralization
 - A visual Admin UI to manage everything in real time
 
-Whether you're integrating REST APIs, local functions, or full LLM agents, MCP Gateway standardizes access and transport — over HTTP, WebSockets, SSE, or stdio.
+Whether you're integrating REST APIs, local functions, or full LLM agents, MCP Gateway standardizes access and transport — over HTTP, WebSockets, SSE, StreamableHttp or stdio.
 
 ---
 

docs/docs/using/clients/copilot.md

@@ -47,9 +47,26 @@ HTTP or require local stdio, you can insert the bundled **`mcpgateway.wrapper`**
 python -m mcpgateway.utils.create_jwt_token -u admin --exp 10080 --secret my-test-key
 ```
 
+## 🔗 Option 2 · Streamable HTTP (best for prod / remote)
+
+### 2 · Create `.vscode/mcp.json`
+
+```json
+{
+  "servers": {
+    "mcp-gateway": {
+      "type": "http",
+      "url": "https://mcpgateway.example.com/servers/1/mcp/",
+      "headers": {
+        "Authorization": "Bearer <YOUR_JWT_TOKEN>"
+      }
+    }
+  }
+}
+
 ---
 
-## 🔗 Option 2 · Local stdio bridge (`mcpgateway.wrapper`)
+## 🔗 Option 3 · Local stdio bridge (`mcpgateway.wrapper`)
 
 Perfect when:
 

docs/docs/using/clients/mcp-inspector.md

@@ -20,10 +20,11 @@ Point it at any MCP-compliant endpoint — a live Gateway **SSE** stream or
 
 | Use-case | One-liner | What happens |
 |----------|-----------|--------------|
-| **Connect to Gateway (SSE)** |<br/>```bash<br/>npx @modelcontextprotocol/inspector \\<br/>  --url http://localhost:4444/servers/1/sse \\<br/>  --header "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN"<br/>``` | Inspector opens `http://localhost:5173` and attaches **directly** to the gateway stream. |
-| **2 · Spin up the stdio wrapper in-process** |<br/>```bash<br/>export MCP_AUTH_TOKEN=$MCPGATEWAY_BEARER_TOKEN<br/>export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/1<br/><br/>npx @modelcontextprotocol/inspector \\<br/>  python -m mcpgateway.wrapper<br/>``` | Inspector forks `python -m mcpgateway.wrapper`, then connects to its stdio port automatically. |
-| **3 · Same, but via uv / uvenv** |<br/>```bash<br/>npx @modelcontextprotocol/inspector \\<br/>  uvenv run python -m mcpgateway.wrapper<br/>``` | Uses the super-fast **uv** virtual-env if you prefer. |
-| **4 · Wrapper already running** | Launch the wrapper in another shell, then:<br/>```bash<br/>npx @modelcontextprotocol/inspector --stdio<br/>``` | Inspector only opens the GUI and binds to the running stdio server on stdin/stdout. |
+| **1. Connect to Gateway (SSE)** |<br/>```bash<br/>npx @modelcontextprotocol/inspector \\<br/>  --url http://localhost:4444/servers/1/sse \\<br/>  --header "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN"<br/>``` | Inspector opens `http://localhost:5173` and attaches **directly** to the gateway stream. |
+| **2. Connect to Gateway (Streamable HTTP)** |<br/>```bash<br/>npx @modelcontextprotocol/inspector \\<br/>  --url http://localhost:4444/servers/1/mcp/ \\<br/>  --header "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN"<br/>``` | Inspector opens `http://localhost:5173` and attaches **directly** to the gateway stream. |
+| **3 · Spin up the stdio wrapper in-process** |<br/>```bash<br/>export MCP_AUTH_TOKEN=$MCPGATEWAY_BEARER_TOKEN<br/>export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/1<br/><br/>npx @modelcontextprotocol/inspector \\<br/>  python -m mcpgateway.wrapper<br/>``` | Inspector forks `python -m mcpgateway.wrapper`, then connects to its stdio port automatically. |
+| **4 · Same, but via uv / uvenv** |<br/>```bash<br/>npx @modelcontextprotocol/inspector \\<br/>  uvenv run python -m mcpgateway.wrapper<br/>``` | Uses the super-fast **uv** virtual-env if you prefer. |
+| **5 · Wrapper already running** | Launch the wrapper in another shell, then:<br/>```bash<br/>npx @modelcontextprotocol/inspector --stdio<br/>``` | Inspector only opens the GUI and binds to the running stdio server on stdin/stdout. |
 
 ---