You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-3Lines changed: 8 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ An MCP proxy server that aggregates and serves multiple MCP resource servers thr
5
5
## Features
6
6
7
7
-**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.
9
9
-**Flexible Configuration**: Supports multiple client types (`stdio`, `sse` or `streamable-http`) with customizable settings.
10
10
11
11
## Installation
@@ -48,6 +48,7 @@ The server is configured using a JSON file. Below is an example configuration:
48
48
"addr": ":9090",
49
49
"name": "MCP Proxy",
50
50
"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`.
51
52
"options": {
52
53
"panicIfInvalid": false,
53
54
"logEnabled": true,
@@ -116,6 +117,9 @@ Proxy HTTP server configuration
116
117
- `addr`: The address the server listens on.
117
118
- `name`: The name of the server.
118
119
- `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).
119
123
- `options`: Default options for the `mcpServers`.
120
124
121
125
### **`mcpServers`**
@@ -153,8 +157,9 @@ Usage of mcp-proxy:
153
157
print version and exit
154
158
```
155
159
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}`.
0 commit comments