fix minor issue
This commit is contained in:
parent
06f0aeb461
commit
3d085008a8
2 changed files with 17 additions and 3 deletions
18
README.md
18
README.md
|
@ -8,7 +8,6 @@ OpenMCPAuthProxy is a security middleware that implements the Model Context Prot
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Go 1.20 or higher
|
- Go 1.20 or higher
|
||||||
- A running MCP server (SSE transport supported)
|
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
```bash
|
```bash
|
||||||
|
@ -21,11 +20,26 @@ go build -o openmcpauthproxy ./cmd/proxy
|
||||||
|
|
||||||
Create a configuration file `config.yaml` with the following parameters:
|
Create a configuration file `config.yaml` with the following parameters:
|
||||||
|
|
||||||
|
### demo mode configuration:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mcp_server_base_url: "http://localhost:8000" # URL of your MCP server
|
mcp_server_base_url: "http://localhost:8000" # URL of your MCP server
|
||||||
listen_address: ":8080" # Address where the proxy will listen
|
listen_address: ":8080" # Address where the proxy will listen
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### asgardeo configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
mcp_server_base_url: "http://localhost:8000" # URL of your MCP server
|
||||||
|
listen_address: ":8080" # Address where the proxy will listen
|
||||||
|
|
||||||
|
asgardeo:
|
||||||
|
org_name: "your-org-name"
|
||||||
|
client_id: "your-client-id"
|
||||||
|
client_secret: "your-client-secret"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Usage Example
|
## Usage Example
|
||||||
|
|
||||||
### 1. Start the MCP Server
|
### 1. Start the MCP Server
|
||||||
|
@ -70,7 +84,7 @@ python3 echo_server.py
|
||||||
./openmcpauthproxy --demo
|
./openmcpauthproxy --demo
|
||||||
```
|
```
|
||||||
|
|
||||||
The `--demo` flag enables a demonstration mode with pre-configured authentication with [Asgardeo](https://asgardeo.io/).
|
The `--demo` flag enables a demonstration mode with pre-configured authentication with [Asgardeo](https://asgardeo.io/) You can also use the `--asgardeo` flag to use your own Asgardeo configuration.
|
||||||
|
|
||||||
### 3. Connect Using an MCP Client
|
### 3. Connect Using an MCP Client
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ import (
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
demoMode := flag.Bool("demo", false, "Use Asgardeo-based provider (demo).")
|
demoMode := flag.Bool("demo", false, "Use Asgardeo-based provider (demo).")
|
||||||
asgardeoMode := flag.Bool("asgardeo", false, "Use Asgardeo-based provider (demo).")
|
asgardeoMode := flag.Bool("asgardeo", false, "Use Asgardeo-based provider (asgardeo).")
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
// 1. Load config
|
// 1. Load config
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue