Skip to content

Commit 73cd060

Browse files
committed
doc: improve readme
1 parent c3abab2 commit 73cd060

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@
55

66
* **🌐 Web UI Management:** Easily manage all connected MCP servers through an intuitive web interface (optional, requires enabling).
77
* **🔧 Granular Tool Control:** Enable or disable individual tools, and override names/descriptions via the Web UI.
8-
* **🔒 Dual SSE Authentication:** Secure your SSE endpoint with flexible authentication options (`Authorization: Bearer <token>` or `X-API-Key: <key>`).
9-
* **🔄 Improved SSE Session Handling**: More robust handling of client reconnections, relying on server-sent `endpoint` events for session synchronization.
8+
* **🛡️ Flexible Endpoint Authentication:** Secure your HTTP-based endpoints (`/sse`, `/mcp`) with flexible authentication options (`Authorization: Bearer <token>` or `X-API-Key: <key>`).
9+
* **🔄 Robust Session Handling & Concurrency**:
10+
* Improved SSE session handling for client reconnections (relying on server-sent `endpoint` events) and support for concurrent connections.
11+
* Streamable HTTP endpoint (`/mcp`) also supports concurrent client interactions.
12+
* **🚀 Versatile MCP Operations (Server & Proxy):**
13+
* **Acts as a Proxy:** Connects to and aggregates multiple backend MCP servers of various types (Stdio, SSE, Streamable HTTP).
14+
* **Acts as a Server:** Exposes these aggregated capabilities through its own Streamable HTTP (`/mcp`) and SSE (`/sse`) endpoints. Can also run in a pure Stdio mode.
1015
* **✨ Real-time Install Output**: Monitor Stdio server installation progress (stdout/stderr) directly in the Web UI.
1116
* **✨ Web Terminal**: Access a command-line terminal within the Admin UI for direct server interaction (optional, use with caution due to security risks).
1217

README_ZH.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@
66

77
* **🌐 Web UI 管理:** 通过直观的网页界面轻松管理所有连接的 MCP 服务器(可选功能,需要启用)。
88
* **🔧 精细化工具控制:** 通过 Web UI 启用或禁用由已连接 MCP 服务器提供的单个工具,并可覆盖其名称/描述。
9-
* **🔒 多种 SSE 认证方式:** 使用灵活的认证选项保护您的 SSE 端点:
10-
* `Authorization: Bearer <token>` 头部
11-
* `X-API-Key: <key>` 头部 或 `?key=<key>` 查询参数
12-
* **🔄 改进的 SSE 会话处理**: 更健壮地处理客户端重连,依赖服务器发送的 `endpoint` 事件进行会话同步。
9+
* **🛡️ 灵活的端点认证:** 使用灵活的认证选项保护您的基于 HTTP 的端点 (`/sse`, `/mcp`): (`Authorization: Bearer <token>``X-API-Key: <key>`)。
10+
* **🔄 健壮的会话处理与并发支持**:
11+
* 改进的 SSE 会话处理机制,用于客户端重连(依赖服务器发送的 `endpoint` 事件),并支持并发连接。
12+
* Streamable HTTP 端点 (`/mcp`) 同样支持并发客户端交互。
13+
* **🚀 多功能 MCP 操作 (服务器与代理):**
14+
* **代理功能:** 连接并聚合多种类型的后端 MCP 服务器 (Stdio, SSE, Streamable HTTP)。
15+
* **服务器功能:** 通过自身的 Streamable HTTP (`/mcp`) 和 SSE (`/sse`) 端点暴露这些聚合后的能力。也可以作为纯 Stdio 模式运行。
1316
* **✨ 实时安装输出**: 在 Web UI 中直接监控 Stdio 服务器的安装进度(stdout/stderr)。
1417
* **✨ 网页终端**: 在 Admin UI 中访问命令行终端,用于直接与服务器环境交互(可选功能,请谨慎使用,存在安全风险)。
1518

0 commit comments

Comments
 (0)