mirror of
https://github.com/samanhappy/mcphub.git
synced 2025-12-24 02:39:19 -05:00
docs: update README to reflect changes in HTTP endpoint support and deprecate SSE endpoint (#38)
This commit is contained in:
53
README.md
53
README.md
@@ -88,27 +88,45 @@ Open `http://localhost:3000` and log in with your credentials.
|
|||||||
- Group management for organizing servers
|
- Group management for organizing servers
|
||||||
- User administration for access control
|
- User administration for access control
|
||||||
|
|
||||||
### SSE Endpoint
|
### Streamable HTTP Endpoint
|
||||||
|
> As of now, support for streaming HTTP endpoints varies across different AI clients. If you encounter issues, you can use the SSE endpoint or wait for future updates.
|
||||||
|
|
||||||
Connect AI clients (e.g., Claude Desktop, Cursor, Cherry Studio) via:
|
Connect AI clients (e.g., Claude Desktop, Cursor, DeepChat, etc.) via:
|
||||||
|
```
|
||||||
|
http://localhost:3000/mcp
|
||||||
|
```
|
||||||
|
This endpoint provides a unified streamable HTTP interface for all your MCP servers. It allows you to:
|
||||||
|
- Send requests to any configured MCP server
|
||||||
|
- Receive responses in real-time
|
||||||
|
- Easily integrate with various AI clients and tools
|
||||||
|
- Use the same endpoint for all servers, simplifying your integration process
|
||||||
|
|
||||||
|
**Group-Specific Endpoints (Recommended)**:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
For targeted access to specific server groups, use the group-based HTTP endpoint:
|
||||||
|
```
|
||||||
|
http://localhost:3000/mcp/{group}
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `{group}` is the ID or name of the group you created in the dashboard. This allows you to:
|
||||||
|
- Connect to a specific subset of MCP servers organized by use case
|
||||||
|
- Isolate different AI tools to access only relevant servers
|
||||||
|
- Implement more granular access control for different environments or teams
|
||||||
|
|
||||||
|
### SSE Endpoint (Deprecated in Future)
|
||||||
|
|
||||||
|
Connect AI clients (e.g., Claude Desktop, Cursor, DeepChat, etc.) via:
|
||||||
```
|
```
|
||||||
http://localhost:3000/sse
|
http://localhost:3000/sse
|
||||||
```
|
```
|
||||||
|
|
||||||
**Group-Specific Endpoints (Recommended)**:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
For targeted access to specific server groups, use the group-based SSE endpoint:
|
For targeted access to specific server groups, use the group-based SSE endpoint:
|
||||||
```
|
```
|
||||||
http://localhost:3000/sse/{groupId}
|
http://localhost:3000/sse/{group}
|
||||||
```
|
```
|
||||||
|
|
||||||
Where `{groupId}` is the ID of the group you created in the dashboard. This allows you to:
|
|
||||||
- Connect to a specific subset of MCP servers organized by use case
|
|
||||||
- Isolate different AI tools to access only relevant servers
|
|
||||||
- Implement more granular access control for different environments or teams
|
|
||||||
|
|
||||||
## 🧑💻 Local Development
|
## 🧑💻 Local Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -120,6 +138,17 @@ pnpm dev
|
|||||||
|
|
||||||
This starts both frontend and backend in development mode with hot-reloading.
|
This starts both frontend and backend in development mode with hot-reloading.
|
||||||
|
|
||||||
|
> For windows users, you may need to start the backend server and frontend separately: `pnpm backend:dev`, `pnpm frontend:dev`.
|
||||||
|
|
||||||
|
## 🛠️ Common Issues
|
||||||
|
|
||||||
|
### Using Nginx as a Reverse Proxy
|
||||||
|
If you are using Nginx to reverse proxy MCPHub, please make sure to add the following configuration in your Nginx setup:
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
proxy_buffering off
|
||||||
|
```
|
||||||
|
|
||||||
## 🔍 Tech Stack
|
## 🔍 Tech Stack
|
||||||
|
|
||||||
- **Backend**: Node.js, Express, TypeScript
|
- **Backend**: Node.js, Express, TypeScript
|
||||||
|
|||||||
52
README.zh.md
52
README.zh.md
@@ -88,27 +88,44 @@ docker run -p 3000:3000 samanhappy/mcphub
|
|||||||
- 分组管理,组织服务器访问
|
- 分组管理,组织服务器访问
|
||||||
- 用户管理,设定权限
|
- 用户管理,设定权限
|
||||||
|
|
||||||
### SSE 端点集成
|
### 支持流式的 HTTP 端点
|
||||||
|
> 截至目前,各家 AI 客户端对流式的 HTTP 端点支持不一,如果遇到问题,可以使用 SSE 端点或者等待更新。
|
||||||
|
|
||||||
通过以下地址连接 AI 客户端(如 Claude Desktop、Cursor、Cherry Studio 等):
|
通过以下地址连接 AI 客户端(如 Claude Desktop、Cursor、DeepChat 等):
|
||||||
|
```
|
||||||
|
http://localhost:3000/mcp
|
||||||
|
```
|
||||||
|
这个端点为所有 MCP 服务器提供统一的流式 HTTP 接口。它允许您:
|
||||||
|
- 向任何配置的 MCP 服务器发送请求
|
||||||
|
- 实时接收响应
|
||||||
|
- 轻松与各种 AI 客户端和工具集成
|
||||||
|
- 对所有服务器使用相同的端点,简化集成过程
|
||||||
|
|
||||||
|
**基于分组的 HTTP 端点(推荐)**:
|
||||||
|

|
||||||
|
要针对特定服务器分组进行访问,请使用基于分组的 HTTP 端点:
|
||||||
|
```
|
||||||
|
http://localhost:3000/mcp/{group}
|
||||||
|
```
|
||||||
|
其中 `{group}` 是您在控制面板中创建的分组 ID 或名称。这样做可以:
|
||||||
|
- 连接到按用例组织的特定 MCP 服务器子集
|
||||||
|
- 隔离不同的 AI 工具,使其只能访问相关服务器
|
||||||
|
- 为不同环境或团队实现更精细的访问控制
|
||||||
|
- 通过分组名称轻松识别和管理服务器
|
||||||
|
- 允许不同的 AI 客户端使用相同的端点,简化集成过程
|
||||||
|
|
||||||
|
### SSE 端点集成 (即将废弃)
|
||||||
|
|
||||||
|
通过以下地址连接 AI 客户端(如 Claude Desktop、Cursor、DeepChat 等):
|
||||||
```
|
```
|
||||||
http://localhost:3000/sse
|
http://localhost:3000/sse
|
||||||
```
|
```
|
||||||
|
|
||||||
**基于分组的 SSE 端点(推荐)**:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
要针对特定服务器分组进行访问,请使用基于分组的 SSE 端点:
|
要针对特定服务器分组进行访问,请使用基于分组的 SSE 端点:
|
||||||
```
|
```
|
||||||
http://localhost:3000/sse/{groupId}
|
http://localhost:3000/sse/{group}
|
||||||
```
|
```
|
||||||
|
|
||||||
其中 `{groupId}` 是您在控制面板中创建的分组 ID。这样做可以:
|
|
||||||
- 连接到按用例组织的特定 MCP 服务器子集
|
|
||||||
- 隔离不同的 AI 工具,使其只能访问相关服务器
|
|
||||||
- 为不同环境或团队实现更精细的访问控制
|
|
||||||
|
|
||||||
## 🧑💻 本地开发
|
## 🧑💻 本地开发
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -120,6 +137,17 @@ pnpm dev
|
|||||||
|
|
||||||
此命令将在开发模式下启动前后端,并启用热重载。
|
此命令将在开发模式下启动前后端,并启用热重载。
|
||||||
|
|
||||||
|
> 针对 Windows 用户,可能需要分别启动后端服务器和前端:`pnpm backend:dev`,`pnpm frontend:dev`。
|
||||||
|
|
||||||
|
## 🛠️ 常见问题
|
||||||
|
|
||||||
|
### 使用 nginx 反向代理
|
||||||
|
如果您在使用 nginx 反向代理 MCPHub,请确保在 nginx 配置中添加以下内容:
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
proxy_buffering off
|
||||||
|
```
|
||||||
|
|
||||||
## 🔍 技术栈
|
## 🔍 技术栈
|
||||||
|
|
||||||
- **后端**:Node.js、Express、TypeScript
|
- **后端**:Node.js、Express、TypeScript
|
||||||
|
|||||||
Reference in New Issue
Block a user