MCP TypeScript SDK (V2)
    Preparing search index...

    Interface AuthMetadataOptions

    Options for mcpAuthMetadataRouter.

    interface AuthMetadataOptions {
        oauthMetadata: {
            authorization_endpoint: string;
            client_id_metadata_document_supported?: boolean;
            code_challenge_methods_supported?: string[];
            grant_types_supported?: string[];
            introspection_endpoint?: string;
            introspection_endpoint_auth_methods_supported?: string[];
            introspection_endpoint_auth_signing_alg_values_supported?: string[];
            issuer: string;
            registration_endpoint?: string;
            response_modes_supported?: string[];
            response_types_supported: string[];
            revocation_endpoint?: string;
            revocation_endpoint_auth_methods_supported?: string[];
            revocation_endpoint_auth_signing_alg_values_supported?: string[];
            scopes_supported?: string[];
            service_documentation?: string;
            token_endpoint: string;
            token_endpoint_auth_methods_supported?: string[];
            token_endpoint_auth_signing_alg_values_supported?: string[];
            [key: string]: unknown;
        };
        resourceName?: string;
        resourceServerUrl: URL;
        scopesSupported?: string[];
        serviceDocumentationUrl?: URL;
    }
    Index

    Properties

    oauthMetadata resourceName? resourceServerUrl scopesSupported? serviceDocumentationUrl?

    Properties

    oauthMetadata: {
        authorization_endpoint: string;
        client_id_metadata_document_supported?: boolean;
        code_challenge_methods_supported?: string[];
        grant_types_supported?: string[];
        introspection_endpoint?: string;
        introspection_endpoint_auth_methods_supported?: string[];
        introspection_endpoint_auth_signing_alg_values_supported?: string[];
        issuer: string;
        registration_endpoint?: string;
        response_modes_supported?: string[];
        response_types_supported: string[];
        revocation_endpoint?: string;
        revocation_endpoint_auth_methods_supported?: string[];
        revocation_endpoint_auth_signing_alg_values_supported?: string[];
        scopes_supported?: string[];
        service_documentation?: string;
        token_endpoint: string;
        token_endpoint_auth_methods_supported?: string[];
        token_endpoint_auth_signing_alg_values_supported?: string[];
        [key: string]: unknown;
    }

    Authorization Server metadata (RFC 8414) for the AS this MCP server relies on. Served at /.well-known/oauth-authorization-server so legacy clients that probe the resource origin still discover the AS.

    resourceName?: string

    Optional human-readable name advertised as resource_name.

    resourceServerUrl: URL

    The public URL of this MCP server, used as the resource value in the Protected Resource Metadata document. Any path component is reflected in the well-known route per RFC 9728.

    scopesSupported?: string[]

    Optional list of scopes this MCP server understands, advertised as scopes_supported.

    serviceDocumentationUrl?: URL

    Optional documentation URL advertised as resource_documentation.

    Settings

    Member Visibility

    On This Page

    Properties