mcp-use TypeScript API
    Preparing search index...

    Interface KeycloakOAuthProviderOptions

    Configures Keycloak JWT verification and protected-resource metadata.

    interface KeycloakOAuthProviderOptions {
        realm: string;
        requiredScopes?: readonly string[];
        resource?: string | URL;
        resourceName?: string;
        scopesSupported?: readonly string[];
        serverUrl: string | URL;
        serviceDocumentationUrl?: URL;
    }

    Hierarchy (View Summary)

    Index
    realm requiredScopes? resource? resourceName? scopesSupported? serverUrl serviceDocumentationUrl?
    realm: string

    Keycloak realm that issues accepted access tokens.

    requiredScopes?: readonly string[]

    Endpoint-wide scopes enforced by the SDK bearer gate.

    resource?: string | URL

    Full canonical public MCP endpoint URL.

    resourceName?: string

    Human-readable name advertised by protected-resource metadata.

    scopesSupported?: readonly string[]

    Scopes advertised by protected-resource metadata.

    serverUrl: string | URL

    Base URL of the Keycloak server.

    serviceDocumentationUrl?: URL

    Documentation URL advertised by protected-resource metadata.

    Settings
    Member Visibility

    On This Page
    Properties