diff --git a/README.zh.md b/README.zh.md index 07443d5..a5cf9cc 100644 --- a/README.zh.md +++ b/README.zh.md @@ -68,11 +68,13 @@ MCPHub 是一个统一的 MCP(Model Context Protocol,模型上下文协议 ### Docker 部署 **推荐**:挂载自定义配置: + ```bash docker run -p 3000:3000 -v $(pwd)/mcp_settings.json:/app/mcp_settings.json samanhappy/mcphub ``` 或使用默认配置运行: + ```bash docker run -p 3000:3000 samanhappy/mcphub ``` @@ -80,22 +82,28 @@ docker run -p 3000:3000 samanhappy/mcphub ### 访问控制台 打开 `http://localhost:3000`,使用您的账号登录。 + > **提示**:默认用户名/密码为 `admin` / `admin123`。 **控制台功能**: + - 实时监控所有 MCP 服务器状态 - 启用/禁用或重新配置服务器 - 分组管理,组织服务器访问 - 用户管理,设定权限 ### 支持流式的 HTTP 端点 + > 截至目前,各家 AI 客户端对流式的 HTTP 端点支持不一,如果遇到问题,可以使用 SSE 端点或者等待更新。 通过以下地址连接 AI 客户端(如 Claude Desktop、Cursor、DeepChat 等): + ``` http://localhost:3000/mcp ``` + 这个端点为所有 MCP 服务器提供统一的流式 HTTP 接口。它允许您: + - 向任何配置的 MCP 服务器发送请求 - 实时接收响应 - 轻松与各种 AI 客户端和工具集成 @@ -104,10 +112,13 @@ http://localhost:3000/mcp **基于分组的 HTTP 端点(推荐)**: ![分组](assets/group.zh.png) 要针对特定服务器分组进行访问,请使用基于分组的 HTTP 端点: + ``` http://localhost:3000/mcp/{group} ``` + 其中 `{group}` 是您在控制面板中创建的分组 ID 或名称。这样做可以: + - 连接到按用例组织的特定 MCP 服务器子集 - 隔离不同的 AI 工具,使其只能访问相关服务器 - 为不同环境或团队实现更精细的访问控制 @@ -117,11 +128,13 @@ http://localhost:3000/mcp/{group} ### SSE 端点集成 (即将废弃) 通过以下地址连接 AI 客户端(如 Claude Desktop、Cursor、DeepChat 等): + ``` http://localhost:3000/sse ``` 要针对特定服务器分组进行访问,请使用基于分组的 SSE 端点: + ``` http://localhost:3000/sse/{group} ``` @@ -142,6 +155,7 @@ pnpm dev ## 🛠️ 常见问题 ### 使用 nginx 反向代理 + 如果您在使用 nginx 反向代理 MCPHub,请确保在 nginx 配置中添加以下内容: ```nginx @@ -168,6 +182,10 @@ proxy_buffering off +如果觉得项目有帮助,不妨请我喝杯咖啡 ☕️ + + + ## 📄 许可证 本项目采用 [Apache 2.0 许可证](LICENSE)。 diff --git a/assets/reward.png b/assets/reward.png new file mode 100644 index 0000000..dafae02 Binary files /dev/null and b/assets/reward.png differ