mcp-use TypeScript API
    Preparing search index...

    Interface AutoOAuthOptions

    Options forwarded to the platform createOAuthProvider when the client auto-provisions OAuth for an HTTP server. Platform-specific fields (e.g. Node openBrowser, browser oauthProxyUrl) are accepted and ignored by the other runtime.

    interface AutoOAuthOptions {
        authTimeoutMs?: number;
        callbackUrl?: string;
        clientMetadataUrl?: string;
        clientName?: string;
        clientUri?: string;
        logoUri?: string;
        oauthProxyUrl?: string;
        openBrowser?: (url: string) => void | Promise<void>;
        portRange?: number;
        preferredPort?: number;
        preventAutoAuth?: boolean;
        proxyOAuthRequests?: boolean;
        scope?: string;
        staticClientInfo?: {};
        storageKeyPrefix?: string;
        useRedirectFlow?: boolean;
    }
    Index
    authTimeoutMs? callbackUrl? clientMetadataUrl? clientName? clientUri? logoUri? oauthProxyUrl? openBrowser? portRange? preferredPort? preventAutoAuth? proxyOAuthRequests? scope? staticClientInfo? storageKeyPrefix? useRedirectFlow?
    authTimeoutMs?: number

    Node loopback callback timeout in milliseconds. Defaults to five minutes.

    callbackUrl?: string

    OAuth redirect URI. The platform provider supplies a default when omitted.

    clientMetadataUrl?: string

    URL of an OAuth Client ID Metadata Document.

    clientName?: string

    OAuth client display name.

    clientUri?: string

    Public URL describing the OAuth client.

    logoUri?: string

    Public URL for the OAuth client logo.

    oauthProxyUrl?: string

    Browser: same-origin OAuth BFF base URL.

    openBrowser?: (url: string) => void | Promise<void>

    Node: override browser launch (CLI prints the URL instead).

    portRange?: number

    Number of Node loopback ports to try. Defaults to 10.

    preferredPort?: number

    Preferred Node loopback port. Defaults to 33418.

    preventAutoAuth?: boolean

    Browser: wait for explicit authenticate() instead of auto popup.

    proxyOAuthRequests?: boolean

    Whether browser OAuth HTTP uses oauthProxyUrl. Defaults to true when the URL is set.

    scope?: string

    Space-delimited OAuth scopes to request.

    staticClientInfo?: {}

    Pre-registered public client id (skips DCR).

    storageKeyPrefix?: string

    Prefix used for persisted OAuth session keys.

    useRedirectFlow?: boolean

    Browser: full-page redirect instead of popup.

    Settings
    Member Visibility

    On This Page
    Properties