mirrors/mcphub
1
0
Fork 0
mirror of https://github.com/samanhappy/mcphub.git synced 2025-12-24 02:39:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: enhance README with detailed features, configuration, and installation instructions

Browse Source
This commit is contained in:
samanhappy
2025-04-01 18:09:00 +08:00
parent 4a703b89d8
commit 251f03831f
1 changed files with 28 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -1,12 +1,17 @@
# MCPHub
A hub server for MCP servers.
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.
## 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
## Configuration
MCP Hub allows you to configure multiple MCP servers. You can add as many stdio/sse MCP servers as you want.
The configuration file should be named `mcp_settings.json` and placed in the root directory of the project.
Create a `mcp_settings.json` file in your project root:
```json
{
@@ -25,41 +30,37 @@ The configuration file should be named `mcp_settings.json` and placed in the roo
## Installation
### Using Docker
1. Add your `mcp_settings.json` file to the current directory.
2. Run the following command to start the Docker container:
### Docker (Recommended)
```bash
docker run -p 3000:3000 -v ./mcp_settings.json:/app/mcp_settings.json samanhappy/mcphub
docker run -p 3000:3000 -v $(pwd)/mcp_settings.json:/app/mcp_settings.json samanhappy/mcphub
```
### Local Installation
1. Clone the repository:
### Manual Installation
```bash
git clone https://github.com/samanhappy/mcphub.git
cd mcphub
```
2. Install dependencies:
```bash
pnpm install
```
3. Run the server:
```bash
pnpm dev
```
## Usage
1. Visit Dashboard UI at `http://localhost:3000` to see the status of your MCP servers.
### Dashboard
Access the monitoring UI at `http://localhost:3000`
![](assets/dashboard.png)
![Dashboard Preview](assets/dashboard.png)
2. Use sse endpoint in any application: `http://localhost:3000/sse`
### 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)