Skip to content

Commit 1c1aab1

Browse files
committed
document
Signed-off-by: Maia Iyer <maia.raj.iyer@gmail.com>
1 parent 51080f9 commit 1c1aab1

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

mcp/slack_tool/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@ You can configure the server with the following environment variables:
1212
| `SLACK_BOT_TOKEN` | Yes | - | Bot token for the Slack server. Required for any functionality |
1313
| `LOG_LEVEL` | No | `DEBUG` | Application log level |
1414
| `MCP_TRANSPORT` | No | `streamable-http` | Passed into mcp.run to determine mcp transport |
15-
| `ISSUER` | No | - | If populated, will publish that it is OAuth-secured by this issuer (but no actual verification). Must be URI format |
16-
| `INTROSPECTION_ENDPOINT` | No | - | If populated with `CLIENT_ID` and `CLIENT_SECRET`, will introspect access tokens at this endpoint |
17-
| `CLIENT_ID` | No | - | If populated with `INTROSPECTION_ENDPOINT` and `CLIENT_SECRET`, will introspect access tokens using this as the client id to authenticate |
18-
| `CLIENT_SECRET` | No | - | If populated with `INTROSPECTION_ENDPOINT` and `CLIENT_ID`, will introspect access tokens using this as the client secret to authenticate |
19-
| `AUDIENCE ` | No | - | If populated with `INTROSPECTION_ENDPOINT` will perform audience validation |
15+
| `JWKS_URI` | No | - | If populated, will perform token validation using the JWKS endpoint |
16+
| `ISSUER` | No | - | If populated with `JWKS_URI`, will additionally check the `iss` claim during token validation |
17+
| `AUDIENCE` | No | - | If populated with `JWKS_URI`, will additionally check the `aud` claim during token validation |
2018
| `ADMIN_SLACK_BOT_TOKEN` | No | - | Bot token for Slack server with Admin privileges. Required for fine grained authz |
2119
| `ADMIN_SCOPE_NAME` | No | - | Scope that triggers `ADMIN_SLACK_BOT_TOKEN` to be used |
2220

23-
Note: `ISSUER` only affects the published authorization endpoint. All three of `INTROSPECTION_ENDPOINT`, `CLIENT_ID`, and `CLIENT_SECRET` are required for token validation to occur. `AUDIENCE` enables the additional audience check.
21+
Note: `JWKS_URI` triggers token validation at runtime. `ISSUER` and `AUDIENCE` will not affect behavior if `JWKS_URI` is not implemented.
2422

2523
Note: Fine-grained authz is enabled with `ADMIN_SLACK_BOT_TOKEN` and `ADMIN_SCOPE_NAME`. If a received access token includes the `ADMIN_SCOPE_NAME` as a scope, it will use the `ADMIN_SLACK_BOT_TOKEN`
2624

0 commit comments

Comments
 (0)