Update README.md

This commit is contained in:
Pavindu Lakshan 2025-04-27 17:23:13 +05:30 committed by GitHub
parent 87a1cbe21a
commit 4a5cf4e1cc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -47,15 +47,7 @@ Open MCP Auth Proxy sits between MCP clients and your MCP server to:
### Basic Usage ### Basic Usage
1. The repository comes with a default `config.yaml` file that contains the basic configuration: 1. Download the latest release from [Github releases](https://github.com/wso2/open-mcp-auth-proxy/releases/latest).
```yaml
listen_port: 8080
base_url: "http://localhost:8000" # Your MCP server URL
paths:
sse: "/sse"
messages: "/messages/"
```
2. Start the proxy in demo mode (uses pre-configured authentication with Asgardeo sandbox): 2. Start the proxy in demo mode (uses pre-configured authentication with Asgardeo sandbox):
@ -63,6 +55,16 @@ paths:
./openmcpauthproxy --demo ./openmcpauthproxy --demo
``` ```
> The repository comes with a default `config.yaml` file that contains the basic configuration:
>
> ```yaml
> listen_port: 8080
> base_url: "http://localhost:8000" # Your MCP server URL
> paths:
> sse: "/sse"
> messages: "/messages/"
> ```
3. Connect using an MCP client like [MCP Inspector](https://github.com/shashimalcse/inspector)(This is a temporary fork with fixes for authentication [issues](https://github.com/modelcontextprotocol/typescript-sdk/issues/257) in the original implementation) 3. Connect using an MCP client like [MCP Inspector](https://github.com/shashimalcse/inspector)(This is a temporary fork with fixes for authentication [issues](https://github.com/modelcontextprotocol/typescript-sdk/issues/257) in the original implementation)
## Connect an Identity Provider ## Connect an Identity Provider