diff --git a/README.md b/README.md index 236f473..b4a1ba1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# supergateway +# mcp-supergateway +Dockerized [supergateway](https://www.npmjs.com/package/supergateway) image bundling several popular +MCP servers (fetch, google-maps, context7, puppeteer, excel, brave-search, ...) so each one can be +exposed as an SSE endpoint via docker-compose. + +## Usage + +1. Copy `.env.example` (or create `.env`) and fill in the API keys the services you enable require. +2. Start the stack: + +```bash +docker compose up -d +``` + +3. Point any MCP-compatible client at the exposed SSE endpoints (one per service/port defined in + `docker-compose.yml`). + +## Client configuration + +Example of connecting an SSE-capable MCP client: + +```json +{ + "mcpServers": { + "fetch": { + "type": "sse", + "url": "http://localhost:8001/sse" + }, + "brave-search": { + "type": "sse", + "url": "http://localhost:8010/sse" + } + } +} +```