From 3d085008a86865d17f6c18afaef6de4bcfa34ade Mon Sep 17 00:00:00 2001 From: Thilina Shashimal Senarath Date: Wed, 2 Apr 2025 22:50:33 +0530 Subject: [PATCH] fix minor issue --- README.md | 18 ++++++++++++++++-- cmd/proxy/main.go | 2 +- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c13d162..65259a2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ OpenMCPAuthProxy is a security middleware that implements the Model Context Prot ### Prerequisites - Go 1.20 or higher -- A running MCP server (SSE transport supported) ### Installation ```bash @@ -21,11 +20,26 @@ go build -o openmcpauthproxy ./cmd/proxy Create a configuration file `config.yaml` with the following parameters: +### demo mode configuration: + ```yaml mcp_server_base_url: "http://localhost:8000" # URL of your MCP server 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 ### 1. Start the MCP Server @@ -70,7 +84,7 @@ python3 echo_server.py ./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 diff --git a/cmd/proxy/main.go b/cmd/proxy/main.go index 2308eee..f02d9c3 100644 --- a/cmd/proxy/main.go +++ b/cmd/proxy/main.go @@ -17,7 +17,7 @@ import ( func main() { 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() // 1. Load config