doc: readme

This commit is contained in:
Timothy Jaeryang Baek
2025-04-12 12:19:30 -07:00
parent 77fbb9a727
commit 650912c5ee
2 changed files with 12 additions and 3 deletions

View File

@@ -40,6 +40,12 @@ pip install mcpo
mcpo --port 8000 --api-key "top-secret" -- your_mcp_server_command
```
To use an SSE-compatible MCP server, simply specify the server type and endpoint:
```bash
mcpo --port 8000 --api-key "top-secret" --server-type "sse" -- http://127.0.0.1:8001/sse
```
You can also run mcpo via Docker with no installation:
```bash
@@ -78,7 +84,10 @@ Example config.json:
"time": {
"command": "uvx",
"args": ["mcp-server-time", "--local-timezone=America/New_York"]
}
},
"mcp_sse": {
"url": "http://127.0.0.1:8001/sse"
} // SSE MCP Server
}
}
```

View File

@@ -34,8 +34,8 @@ def main(
typer.Option("--env-path", help="Path to environment variables file"),
] = None,
server_type: Annotated[
Optional[str], typer.Option("--type", help="Server type")
] = None,
Optional[str], typer.Option("--type", "--server-type", help="Server type")
] = "stdio",
config_path: Annotated[
Optional[str], typer.Option("--config", "-c", help="Config file path")
] = None,