docs: update README to enhance feature descriptions and quick start instructions; improve dashboard management details

This commit is contained in:
samanhappy
2025-04-02 11:16:17 +08:00
parent d256590329
commit 3a97119719
2 changed files with 39 additions and 34 deletions

View File

@@ -1,17 +1,49 @@
# MCPHub # MCPHub: Multiple Servers, Single Endpoint, Zero Hassle
MCPHub is a unified hub server that consolidates multiple MCP (Model Context Protocol) servers into a single SSE endpoint. It simplifies service management and provides a centralized interface for all your MCP needs. MCPHub is a unified hub server that consolidates multiple MCP (Model Context Protocol) servers into a single SSE endpoint. It simplifies service management and provides a centralized interface for all your MCP needs.
![Dashboard Preview](assets/dashboard.png)
## Features ## Features
- **Centralized Management**: Manage multiple MCP servers from a single hub - **Centralized Management**: Manage multiple MCP servers from a single hub
- **Protocol Support**: Compatible with stdio and SSE MCP protocols - **Protocol Support**: Compatible with stdio and SSE MCP protocols
- **Dashboard UI**: Monitor server status through a web interface - **Dashboard UI**: Monitor server status and dynamically manage servers through a web interface
- **Easy Configuration**: Simple JSON-based configuration system - **Dynamic Management**: Add, remove, or reconfigure MCP servers without restarting the hub
## Configuration ## Quick Start
Create a `mcp_settings.json` file in your project root: ### Docker
```bash
docker run -p 3000:3000 samanhappy/mcphub
```
### Dashboard
Access the interactive management UI at `http://localhost:3000`
The dashboard provides:
- 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
Connect your Host App, such as Claude Desktop, Cursor, Cherry Studio, and more, seamlessly to `http://localhost:3000/sse`.
## Local Development
### Clone the Repository
```bash
git clone https://github.com/samanhappy/mcphub.git
```
### Configuration (Optional)
Edit the `mcp_settings.json` file:
```json ```json
{ {
@@ -28,39 +60,12 @@ Create a `mcp_settings.json` file in your project root:
} }
``` ```
## Installation ### Start the Server
### Docker (Recommended)
```bash ```bash
docker run -p 3000:3000 -v $(pwd)/mcp_settings.json:/app/mcp_settings.json samanhappy/mcphub cd mcphub && pnpm install && pnpm dev
``` ```
### Manual Installation
```bash
git clone https://github.com/samanhappy/mcphub.git
cd mcphub
pnpm install
pnpm dev
```
## Usage
### Dashboard
Access the monitoring UI at `http://localhost:3000`
![Dashboard Preview](assets/dashboard.png)
### API Endpoint
Connect your applications to `http://localhost:3000/sse`
## Requirements
- Node.js 14+ (for manual installation)
- Docker (for containerized deployment)
## License ## License
[MIT License](LICENSE) [MIT License](LICENSE)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 11 KiB