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

    Type Alias AuthEnvVarExperimental

    UNSTABLE

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

    Describes a single environment variable for an [AuthMethodEnvVar] authentication method.

    type AuthEnvVar = {
        _meta?: { [key: string]: unknown } | null;
        label?: string | null;
        name: string;
        optional?: boolean;
        secret?: boolean;
    }
    Index

    Properties

    _meta? label? name optional? secret?

    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

    label?: string | null

    Human-readable label for this variable, displayed in client UI.

    name: string

    The environment variable name (e.g. "OPENAI_API_KEY").

    optional?: boolean

    Whether this variable is optional.

    Defaults to false.

    secret?: boolean

    Whether this value is a secret (e.g. API key, token). Clients should use a password-style input for secret vars.

    Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties