docs: update README.md to include usage instructions and configuration for mcp_settings.json

This commit is contained in:
samanhappy
2025-03-31 20:07:51 +08:00
parent ff2ff8a941
commit ea3bcb4d79

View File

@@ -2,15 +2,38 @@
A hub server for MCP servers.
## Installation
## Usage
1. Create a configuration file named `mcp_settings.json` with your MCP server settings:
```json
{
"mcpServers": {
"time-mcp": {
"command": "npx",
"args": ["-y", "time-mcp"]
},
"sequential-thinking": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-sequential-thinking"
]
}
}
}
```
2. Run MCP Hub using Docker:
```bash
docker run -p 3000:3000 -v ./mcp_settings.json:/app/mcp_settings.json samanhappy/mcphub
```
This will:
- Map port 3000 from the container to your local machine
- Mount your local configuration file into the container
- Start the MCP Hub server
3. The server will be available at `http://localhost:3000/sse`
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Create a `.env` file based on `.env.example`
4. Run the development server:
```bash
npm run dev
```