Agent Client Protocol - v0.18.2
    Preparing search index...

    Type Alias AuthMethodEnvVarExperimental

    UNSTABLE

    This capability is not part of the spec yet, and may be removed or changed at any point.

    Environment variable authentication method.

    The user provides credentials that the client passes to the agent as environment variables.

    type AuthMethodEnvVar = {
        _meta?: { [key: string]: unknown } | null;
        description?: string | null;
        id: string;
        link?: string | null;
        name: string;
        vars: AuthEnvVar[];
    }
    Index

    Properties

    _meta? description? id link? name vars

    Properties

    Optional_meta

    _meta?: { [key: string]: unknown } | null

    The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

    See protocol docs: Extensibility

    description?: string | null

    Optional description providing more details about this authentication method.

    id: string

    Unique identifier for this authentication method.

    link?: string | null

    Optional link to a page where the user can obtain their credentials.

    name: string

    Human-readable name of the authentication method.

    vars: AuthEnvVar[]

    The environment variables the client should set.

    Settings

    Member Visibility

    On This Page

    Properties