docs: enhance README and Chinese translation for clarity and consistency

This commit is contained in:
samanhappy
2025-04-04 15:54:59 +08:00
parent df8b8a6829
commit ffd6b93c2c
2 changed files with 53 additions and 39 deletions

View File

@@ -2,50 +2,55 @@
English | [中文版](README.zh.md)
MCPHub is a unified hub server that consolidates multiple MCP (Model Context Protocol) servers into one single SSE endpoint. It simplifies service management and provides a centralized interface for all your MCP server needs.
MCPHub is a unified hub server that consolidates multiple MCP (Model Context Protocol) servers into a single SSE endpoint. It streamlines service management by offering a centralized interface for all your MCP server needs.
![Dashboard Preview](assets/dashboard.png)
## Features
- **Centralized Management**: Manage multiple MCP servers from a single hub
- **Protocol Support**: Compatible with stdio and SSE MCP protocols
- **Dashboard UI**: Monitor server status and dynamically manage servers through a web interface
- **Dynamic Management**: Add, remove, or reconfigure MCP servers without restarting the hub
- **Centralized Management**: Oversee multiple MCP servers from one convenient hub.
- **Broad Protocol Support**: Works seamlessly with both stdio and SSE MCP protocols.
- **Intuitive Dashboard UI**: Monitor server status and manage servers dynamically via a web interface.
- **Flexible Server Management**: Add, remove, or reconfigure MCP servers without restarting the hub.
## Quick Start
### Docker
### Using Docker
Run the following command to quickly launch MCPHub:
```bash
docker run -p 3000:3000 samanhappy/mcphub
```
### Dashboard
### Dashboard Access
Access the interactive management UI at `http://localhost:3000`
Open your web browser and navigate to:
`http://localhost:3000`
The dashboard provides:
- **Real-Time Monitoring**: Keep an eye on the status of all MCP servers.
- **Service Status Indicators**: Quickly see which services are online.
- **Dynamic Server Management**: Add or remove MCP servers on the fly without needing to restart.
- Real-time monitoring of all MCP servers
- Status indicators for all connected services
- Dynamic addition or removal of new MCP servers without restarting
### SSE Endpoint
### SSE endpoint
Connect your Host App, such as Claude Desktop, Cursor, Cherry Studio, and more, seamlessly to `http://localhost:3000/sse`.
Seamlessly connect your host applications (e.g., Claude Desktop, Cursor, Cherry Studio, etc.) to the MCPHub SSE endpoint at:
`http://localhost:3000/sse`
## Local Development
### Clone the Repository
Clone MCPHub from GitHub:
```bash
git clone https://github.com/samanhappy/mcphub.git
```
### Configuration (Optional)
### Optional Configuration
Edit the `mcp_settings.json` file:
Customize your MCP server settings by editing the `mcp_settings.json` file. For example:
```json
{
@@ -62,7 +67,9 @@ Edit the `mcp_settings.json` file:
}
```
### Start the Server
### Start the Development Server
Install dependencies and launch MCPHub:
```bash
cd mcphub && pnpm install && pnpm dev
@@ -70,4 +77,4 @@ cd mcphub && pnpm install && pnpm dev
## License
[MIT License](LICENSE)
This project is licensed under the [MIT License](LICENSE).

View File

@@ -1,51 +1,56 @@
# MCPHub: 一个端点,无限 MCP 服务器
# MCPHub一个端点,无限 MCP 服务器
[English Version](README.md) | 中文版
MCPHub 是一统一的集线器服务器,将多个 MCPModel Context Protocol服务器整合一个 SSE 端点。它简化服务管理并为所有 MCP 服务器需求提供了集中式接口
MCPHub 是一统一的中心服务器,可以将多个 MCPModel Context Protocol服务器整合一个 SSE 端点。它通过提供一个集中的管理界面来简化服务管理,满足您对 MCP 服务器的所有需求。
![仪表盘预览](assets/dashboard.png)
## 功能特性
## 功能
- **集中管理**从单一集线器管理多个 MCP 服务器
- **协议支持**兼容 stdio SSE MCP 协议
- **仪表盘界面**:通过 Web 界面监控服务器状态并动态管理服务器
- **动态管理**:无需重启集线器即可添加、除或重新配置 MCP 服务器
- **集中管理**通过单一中心轻松管理多个 MCP 服务器
- **协议兼容**同时支持 stdio SSE MCP 协议,确保无缝对接。
- **直观仪表盘**:通过 Web 界面实时监控服务器状态并动态管理服务器
- **灵活配置**:无需重启中心服务器即可添加、除或重新配置 MCP 服务器
## 快速开始
### Docker
### 使用 Docker 部署
运行以下命令即可快速启动 MCPHub
```bash
docker run -p 3000:3000 samanhappy/mcphub
```
### 仪表盘
### 仪表盘访问
访问交互式管理界面:`http://localhost:3000`
在浏览器中打开以下地址:
`http://localhost:3000`
仪表盘提供:
- 所有 MCP 服务器的实时监控
- 所有连接服务的状态指示器
- 无需重启即可动态添加或移除新的 MCP 服务器
仪表盘提供以下功能
- **实时监控**:随时查看所有 MCP 服务器的运行状态。
- **服务状态指示**:快速识别各服务是否在线。
- **动态管理**:无需重启即可动态添加或移除 MCP 服务器。
### SSE 端点
将您的宿主应用(如 Claude Desktop、Cursor、Cherry Studio 等)无缝连接`http://localhost:3000/sse`
您可以将主机应用(如 Claude Desktop、Cursor、Cherry Studio 等)无缝连接至 MCPHub 的 SSE 端点:
`http://localhost:3000/sse`
## 本地开发
### 克隆
### 克隆代码
请使用以下命令克隆 MCPHub 仓库:
```bash
git clone https://github.com/samanhappy/mcphub.git
```
### 配置(可选)
### 可选配置
编辑 `mcp_settings.json` 文件:
通过编辑 `mcp_settings.json` 文件来自定义 MCP 服务器设置。例如
```json
{
@@ -62,7 +67,9 @@ git clone https://github.com/samanhappy/mcphub.git
}
```
### 启动服务器
### 启动开发服务器
安装依赖并启动 MCPHub
```bash
cd mcphub && pnpm install && pnpm dev
@@ -70,4 +77,4 @@ cd mcphub && pnpm install && pnpm dev
## 许可证
[MIT 许可证](LICENSE)
本项目采用 [MIT 许可证](LICENSE)