mcp-use TypeScript API
    Preparing search index...

    Interface ConvexOAuthProviderOptions

    Configures Convex JWT verification and protected-resource metadata.

    interface ConvexOAuthProviderOptions {
        authURL?: string | URL;
        requiredScopes?: readonly string[];
        resource?: string | URL;
        resourceName?: string;
        scopesSupported?: readonly string[];
        serviceDocumentationUrl?: URL;
    }

    Hierarchy (View Summary)

    Index
    authURL? requiredScopes? resource? resourceName? scopesSupported? serviceDocumentationUrl?
    authURL?: string | URL

    Complete Convex OAuth issuer URL, including the mounted base path.

    `https://example.convex.site/oauth`

    MCP_USE_OAUTH_CONVEX_AUTH_URL

    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.

    serviceDocumentationUrl?: URL

    Documentation URL advertised by protected-resource metadata.

    Settings
    Member Visibility

    On This Page
    Properties