diff --git a/README.md b/README.md index 742360a..cef5df4 100644 --- a/README.md +++ b/README.md @@ -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. +![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 through a web interface -- **Easy Configuration**: Simple JSON-based configuration system +- **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 -## 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 { @@ -28,39 +60,12 @@ Create a `mcp_settings.json` file in your project root: } ``` -## Installation - -### Docker (Recommended) +### Start the Server ```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 [MIT License](LICENSE) diff --git a/assets/dashboard.png b/assets/dashboard.png index 1a1bf6f..8c3c8a0 100644 Binary files a/assets/dashboard.png and b/assets/dashboard.png differ