mcp-use TypeScript API
    Preparing search index...

    Interface UserContext

    OpenAI-specific end-user hints declared in request metadata.

    All fields are optional, client-reported, and unverified. Use OAuthAuth.user for an authenticated identity.

    interface UserContext {
        conversationId?: string;
        locale?: string;
        location?: {
            city?: string;
            country?: string;
            latitude?: string | number;
            longitude?: string | number;
            region?: string;
            timezone?: string;
        };
        organizationId?: string;
        subject?: string;
        userAgent?: string;
    }
    Index
    conversationId? locale? location? organizationId? subject? userAgent?
    conversationId?: string

    Client-reported conversation hint from openai/session.

    locale?: string

    Requested BCP 47 locale from openai/locale or legacy webplus/i18n.

    location?: {
        city?: string;
        country?: string;
        latitude?: string | number;
        longitude?: string | number;
        region?: string;
        timezone?: string;
    }

    Coarse end-user location from openai/userLocation.

    Type Declaration

    • Optionalcity?: string

      City name, when supplied.

    • Optionalcountry?: string

      Country identifier, when supplied.

    • Optionallatitude?: string | number

      Approximate latitude; clients may encode coordinates as strings or numbers.

    • Optionallongitude?: string | number

      Approximate longitude; clients may encode coordinates as strings or numbers.

    • Optionalregion?: string

      Region or state name, when supplied.

    • Optionaltimezone?: string

      IANA timezone identifier, when supplied.

    organizationId?: string

    Client-reported organization hint from openai/organization.

    subject?: string

    Client-reported subject hint from openai/subject.

    userAgent?: string

    Best-effort browser or host identifier from openai/userAgent.

    Settings
    Member Visibility

    On This Page
    Properties