Skip to content

Commit 17a6210

Browse files
committed
docs: update README to clarify SSE and HTTP streaming support for MCP
1 parent 9f3bd4e commit 17a6210

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ An MCP proxy server that aggregates and serves multiple MCP resource servers thr
55
## Features
66

77
- **Proxy Multiple MCP Clients**: Connects to multiple MCP resource servers and aggregates their tools and capabilities.
8-
- **SSE Support**: Provides an SSE (Server-Sent Events) server for real-time updates.
8+
- **SSE / HTTP Streaming MCPSupport**: Provides an SSE (Server-Sent Events) or HTTP streaming interface for real-time updates from MCP clients.
99
- **Flexible Configuration**: Supports multiple client types (`stdio`, `sse` or `streamable-http`) with customizable settings.
1010

1111
## Installation
@@ -48,6 +48,7 @@ The server is configured using a JSON file. Below is an example configuration:
4848
"addr": ":9090",
4949
"name": "MCP Proxy",
5050
"version": "1.0.0",
51+
"type": "streamable-http",// The transport type of the MCP proxy server, can be `streamable-http`, `sse`. By default, it is `sse`.
5152
"options": {
5253
"panicIfInvalid": false,
5354
"logEnabled": true,
@@ -116,6 +117,9 @@ Proxy HTTP server configuration
116117
- `addr`: The address the server listens on.
117118
- `name`: The name of the server.
118119
- `version`: The version of the server.
120+
- `type`: The transport type of the MCP proxy server. Can be `streamable-http` or `sse`. By default, it is `sse`.
121+
- `streamable-http`: The MCP proxy server supports HTTP streaming.
122+
- `sse`: The MCP proxy server supports Server-Sent Events (SSE).
119123
- `options`: Default options for the `mcpServers`.
120124
121125
### **`mcpServers`**
@@ -153,8 +157,9 @@ Usage of mcp-proxy:
153157
print version and exit
154158
```
155159
1. The server will start and aggregate the tools and capabilities of the configured MCP clients.
156-
2. You can access the server at `http(s)://{baseURL}/{clientName}/sse`. (e.g., `https://mcp.example.com/fetch/sse`, based on the example configuration)
157-
3. If your MCP client does not support custom request headers., you can change the key in `clients` such as `fetch` to `fetch/{authToken}`, and then access it via `fetch/{authToken}`.
160+
2. When MCP Server type is `sse`, You can access the server at `http(s)://{baseURL}/{clientName}/sse`. (e.g., `https://mcp.example.com/fetch/sse`, based on the example configuration)
161+
3. When MCP Server type is `streamable-http`, You can access the server at `http(s)://{baseURL}/{clientName}/mcp`. (e.g., `https://mcp.example.com/fetch/mcp`, based on the example configuration)
162+
4. If your MCP client does not support custom request headers., you can change the key in `clients` such as `fetch` to `fetch/{authToken}`, and then access it via `fetch/{authToken}`.
158163
159164
## Thanks
160165

0 commit comments

Comments
 (0)