mcp-use TypeScript API
    Preparing search index...

    Interface ScalekitOAuthProviderOptions

    Configures Scalekit JWT verification and protected-resource metadata.

    interface ScalekitOAuthProviderOptions {
        audience?: string;
        environmentUrl?: string | URL;
        requiredScopes?: readonly string[];
        resource?: string | URL;
        resourceId?: string;
        resourceName?: string;
        scopesSupported?: readonly string[];
        serviceDocumentationUrl?: URL;
    }

    Hierarchy (View Summary)

    Index
    audience? environmentUrl? requiredScopes? resource? resourceId? resourceName? scopesSupported? serviceDocumentationUrl?
    audience?: string

    Extra JWT audience required together with the resource id.

    Default verification only requires resourceId in aud. Set this when tokens also carry a Server URL and you want both values present. This does not replace the resource-id check.

    environmentUrl?: string | URL

    Scalekit environment URL from the dashboard.

    MCP_USE_OAUTH_SCALEKIT_ENVIRONMENT_URL

    requiredScopes?: readonly string[]

    Endpoint-wide scopes enforced by the SDK bearer gate.

    resource?: string | URL

    Full canonical public MCP endpoint URL.

    resourceId?: string

    MCP resource id (res_…). Default JWT audience and the per-server binding.

    MCP_USE_OAUTH_SCALEKIT_RESOURCE_ID

    resourceName?: string

    Human-readable name advertised by protected-resource metadata.

    scopesSupported?: readonly string[]

    Scopes advertised by protected-resource metadata.

    serviceDocumentationUrl?: URL

    Documentation URL advertised by protected-resource metadata.

    Settings
    Member Visibility

    On This Page
    Properties