mirror of
https://github.com/wso2/open-mcp-auth-proxy.git
synced 2025-06-28 09:24:19 +00:00
Update README.md
This commit is contained in:
parent
52ea1adeba
commit
eb73153330
1 changed files with 36 additions and 27 deletions
63
README.md
63
README.md
|
@ -21,7 +21,7 @@ The proxy intercepts incoming requests and validates Authorization: Bearer token
|
||||||
```
|
```
|
||||||
git clone https://github.com/wso2/open-mcp-auth-proxy
|
git clone https://github.com/wso2/open-mcp-auth-proxy
|
||||||
cd open-mcp-auth-proxy
|
cd open-mcp-auth-proxy
|
||||||
go build \-o openmcpauthproxy ./cmd/proxy
|
go build -o openmcpauthproxy ./cmd/proxy
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using Open MCP Auth Proxy
|
## Using Open MCP Auth Proxy
|
||||||
|
@ -37,51 +37,57 @@ If you don’t have an MCP server, as mentioned in the prerequisites, follow the
|
||||||
Create a configuration file config.yaml with the following parameters:
|
Create a configuration file config.yaml with the following parameters:
|
||||||
|
|
||||||
```
|
```
|
||||||
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
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Start the Auth Proxy
|
#### Start the Auth Proxy
|
||||||
|
|
||||||
```./openmcpauthproxy \--demo```
|
```
|
||||||
|
./openmcpauthproxy --demo
|
||||||
|
```
|
||||||
|
|
||||||
The \--demo flag enables a demonstration mode with pre-configured authentication with a sandbox powered by [Asgardeo](https://asgardeo.io/).
|
The `--demo` flag enables a demonstration mode with pre-configured authentication with a sandbox powered by [Asgardeo](https://asgardeo.io/).
|
||||||
|
|
||||||
#### Connect Using an MCP Client
|
#### Connect Using an MCP Client
|
||||||
|
|
||||||
You can use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) to test the connection:
|
You can use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) to test the connection
|
||||||
|
|
||||||
### Use with Asgardeo
|
### Use with Asgardeo
|
||||||
|
|
||||||
Enable authorization for the MCP server through your own Asgardeo organization
|
Enable authorization for the MCP server through your own Asgardeo organization
|
||||||
|
|
||||||
1. Register for Asgaradeo and create an organization for you
|
1. [Register]([url](https://asgardeo.io/signup)) and create an organization in Asgardeo
|
||||||
2. Create an [M2M application](https://wso2.com/asgardeo/docs/guides/applications/register-machine-to-machine-app/)
|
2. Create an [M2M application](https://wso2.com/asgardeo/docs/guides/applications/register-machine-to-machine-app/)
|
||||||
1. Enable client credential grant
|
1. Authorize “Application Management API” with `internal_application_mgt_create` all scopes
|
||||||
2. Authorize “Application Management API” internal\_application\_mgt\_create all scopes![][image2]
|

|
||||||
|
2. Note the client ID and client secret of this application. This is required by the auth proxy
|
||||||
3. Note the client ID and client secret of this application. This is required by the auth proxy
|
|
||||||
|
|
||||||
#### Configure the Auth Proxy
|
#### Configure the Auth Proxy
|
||||||
|
|
||||||
Create a configuration file config.yaml with the following parameters:
|
Create a configuration file config.yaml with the following parameters:
|
||||||
|
|
||||||
```
|
```
|
||||||
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
|
||||||
```
|
|
||||||
|
|
||||||
TODO: Update the configs for asgardeo.
|
asgardeo:
|
||||||
|
org_name: "<org_name>" # Your Asgardeo org name
|
||||||
|
client_id: "<client_id>" # Client ID of the M2M app
|
||||||
|
client_secret: "<client_secret>" # Client secret of the M2M app
|
||||||
|
```
|
||||||
|
|
||||||
#### Start the Auth Proxy
|
#### Start the Auth Proxy
|
||||||
|
|
||||||
`./openmcpauthproxy \--asgardeo`
|
```
|
||||||
|
./openmcpauthproxy --asgardeo
|
||||||
|
```
|
||||||
|
|
||||||
### Use with Auth0
|
### Use with Auth0
|
||||||
|
|
||||||
Enable authorization for the MCP server through your Auth0 organization
|
Enable authorization for the MCP server through your Auth0 organization
|
||||||
|
|
||||||
TODO: Add instructions
|
**TODO**: Add instructions
|
||||||
|
|
||||||
[Enable dynamic application registration](https://auth0.com/docs/get-started/applications/dynamic-client-registration#enable-dynamic-client-registration) in your Auth0 organization
|
[Enable dynamic application registration](https://auth0.com/docs/get-started/applications/dynamic-client-registration#enable-dynamic-client-registration) in your Auth0 organization
|
||||||
|
|
||||||
|
@ -89,32 +95,35 @@ TODO: Add instructions
|
||||||
|
|
||||||
Create a configuration file config.yaml with the following parameters:
|
Create a configuration file config.yaml with the following parameters:
|
||||||
|
|
||||||
```mcp\_server\_base\_url: "http://localhost:8000" \# URL of your MCP server
|
```
|
||||||
listen\_address: ":8080" \# Address where the proxy will listen
|
mcp_server_base_url: "http://localhost:8000" # URL of your MCP server
|
||||||
|
listen_address: ":8080" # Address where the proxy will listen
|
||||||
```
|
```
|
||||||
|
|
||||||
TODO: Update the configs for Auth0.
|
**TODO**: Update the configs for Auth0.
|
||||||
|
|
||||||
#### Start the Auth Proxy
|
#### Start the Auth Proxy
|
||||||
|
|
||||||
```./openmcpauthproxy \--auth0```
|
```
|
||||||
|
./openmcpauthproxy --auth0
|
||||||
|
```
|
||||||
|
|
||||||
### Use with a standard OAuth Server
|
### Use with a standard OAuth Server
|
||||||
|
|
||||||
Enable authorization for the MCP server with a compliant OAuth server
|
Enable authorization for the MCP server with a compliant OAuth server
|
||||||
|
|
||||||
TODO:Add instructions
|
|
||||||
|
|
||||||
#### Configuration
|
#### Configuration
|
||||||
|
|
||||||
Create a configuration file config.yaml with the following parameters:
|
Create a configuration file config.yaml with the following parameters:
|
||||||
|
|
||||||
```
|
```
|
||||||
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
|
||||||
```
|
```
|
||||||
TODO: Update the configs for a standard OAuth Server.
|
**TODO**: Update the configs for a standard OAuth Server.
|
||||||
|
|
||||||
#### Start the Auth Proxy
|
#### Start the Auth Proxy
|
||||||
|
|
||||||
```./openmcpauthproxy```
|
```
|
||||||
|
./openmcpauthproxy
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue