# MCP WorkOS OAuth Policy

:::note{title="MCP Gateway Policy"}

This policy is for use with the [MCP Gateway](/mcp-gateway/introduction). See
the MCP Gateway documentation to learn how to proxy and secure MCP servers with
Zuplo.

:::

Authenticate MCP gateway requests using a gateway-issued OAuth access token,
with browser login delegated to WorkOS.

This is a WorkOS-friendly wrapper around `McpOAuthInboundPolicy`. Provide
`clientId` + `clientSecret`, and the WorkOS OIDC issuer, JWKS URL, and browser
login endpoints are derived automatically.

## Configuration

The configuration shows how to configure the policy in the 'policies.json' document.

```json title="config/policies.json"
{
  "name": "my-mcp-workos-oauth-inbound-policy",
  "policyType": "mcp-workos-oauth-inbound",
  "handler": {
    "export": "McpWorkosOAuthInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "browserLoginOverrides": {
        "remoteTimeoutMs": 10000,
        "sessionTtlSeconds": 28800,
        "stateTtlSeconds": 900
      },
      "clientId": "$env(WORKOS_CLIENT_ID)",
      "clientSecret": "$env(WORKOS_CLIENT_SECRET)",
      "gateway": {
        "accessTokenTtlSeconds": 900,
        "cimdEnabled": true,
        "refreshTokenTtlSeconds": 2592000
      },
      "scope": "openid profile email"
    }
  }
}
```

### Policy Configuration

- `name` <code className="text-green-600">&lt;string&gt;</code> - The name of your policy instance. This is used as a reference in your routes.
- `policyType` <code className="text-green-600">&lt;string&gt;</code> - The identifier of the policy. This is used by the Zuplo UI. Value should be `mcp-workos-oauth-inbound`.
- `handler.export` <code className="text-green-600">&lt;string&gt;</code> - The name of the exported type. Value should be `McpWorkosOAuthInboundPolicy`.
- `handler.module` <code className="text-green-600">&lt;string&gt;</code> - The module containing the policy. Value should be `$import(@zuplo/runtime)`.
- `handler.options` <code className="text-green-600">&lt;object&gt;</code> - The options for this policy. [See Policy Options](#policy-options) below.

### Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

- `clientId` **(required)** <code className="text-green-600">&lt;string&gt;</code> - The WorkOS client_id registered for the gateway's browser login flow. The OIDC issuer and JWKS URL are derived from this client ID.
- `clientSecret` **(required)** <code className="text-green-600">&lt;string&gt;</code> - The WorkOS client_secret. Use $env(...) to source from a secret environment variable.
- `scope` <code className="text-green-600">&lt;string&gt;</code> - OIDC scopes requested during browser login. Defaults to `"openid profile email"`.
- `gateway` <code className="text-green-600">&lt;object&gt;</code> - Gateway-side OAuth token settings. The gateway issuer and advertised URLs are derived from the incoming request origin.
  - `accessTokenTtlSeconds` <code className="text-green-600">&lt;integer&gt;</code> - Lifetime of access tokens issued by /oauth/token. Defaults to `900`.
  - `refreshTokenTtlSeconds` <code className="text-green-600">&lt;integer&gt;</code> - Lifetime of refresh tokens issued by /oauth/token. Defaults to `2592000`.
  - `cimdEnabled` <code className="text-green-600">&lt;boolean&gt;</code> - Whether to advertise client_id_metadata_document_supported in AS metadata. Defaults to `true`.
- `browserLoginOverrides` <code className="text-green-600">&lt;object&gt;</code> - Optional overrides for the derived browser-login settings.
  - `remoteTimeoutMs` <code className="text-green-600">&lt;integer&gt;</code> - No description available. Defaults to `10000`.
  - `stateTtlSeconds` <code className="text-green-600">&lt;integer&gt;</code> - No description available. Defaults to `900`.
  - `sessionTtlSeconds` <code className="text-green-600">&lt;integer&gt;</code> - No description available. Defaults to `28800`.

## Using the Policy

# MCP WorkOS OAuth Inbound

Authenticate MCP gateway requests using a gateway-issued OAuth access token,
with browser login delegated to WorkOS.

This is a thin WorkOS-friendly wrapper around the generic
`McpOAuthInboundPolicy`. Use it when you want to configure browser login with
just `clientId` + `clientSecret` instead of the full set of OIDC URLs.

## Derived configuration

Given `clientId: "client_01KC6057N3C66XJAXZ65YHAC72"`, the wrapper derives:

| Generic field                                      | Derived value                                                              |
| -------------------------------------------------- | -------------------------------------------------------------------------- |
| `oidc.issuer`                                      | `https://api.workos.com/user_management/client_01KC6057N3C66XJAXZ65YHAC72` |
| `oidc.jwksUrl`                                     | `https://api.workos.com/sso/jwks/client_01KC6057N3C66XJAXZ65YHAC72`        |
| `browserLogin.url`                                 | `https://api.workos.com/user_management/authorize`                         |
| `browserLogin.tokenUrl`                            | `https://api.workos.com/user_management/authenticate`                      |
| `browserLogin.clientId` / `clientSecret` / `scope` | from policy options (`clientSecret` is required)                           |

These endpoint shapes come from WorkOS OIDC discovery at
`https://api.workos.com/user_management/{clientId}/.well-known/openid-configuration`.

## Configuration

```json
{
  "name": "workos-managed-oauth",
  "policyType": "mcp-workos-oauth-inbound",
  "handler": {
    "module": "$import(@zuplo/runtime/mcp-gateway)",
    "export": "McpWorkosOAuthInboundPolicy",
    "options": {
      "clientId": "$env(WORKOS_CLIENT_ID)",
      "clientSecret": "$env(WORKOS_CLIENT_SECRET)"
    }
  }
}
```

`clientId` must be the WorkOS client ID, such as
`client_01KC6057N3C66XJAXZ65YHAC72`. The policy rejects issuer URLs, WorkOS API
hostnames, and values that do not use the `client_` ID shape.

## Pairing

Pair this policy with `McpTokenExchangeInboundPolicy` and `McpProxyHandler`, the
same as `McpOAuthInboundPolicy`. Only one MCP OAuth policy is allowed per
project; attach the same policy by name to every MCP route.

Read more about [how policies work](/articles/policies)