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

    Type Alias StringPropertySchema

    Schema for string properties in an elicitation form.

    When enum or oneOf is set, this represents a single-select enum with "type": "string".

    type StringPropertySchema = {
        title?: string | null;
        description?: string | null;
        minLength?: number | null;
        maxLength?: number | null;
        pattern?: string | null;
        format?: StringFormat | null;
        default?: string | null;
        enum?: string[] | null;
        oneOf?: EnumOption[] | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index

    Properties

    title? description? minLength? maxLength? pattern? format? default? enum? oneOf? _meta?

    Properties

    title?: string | null

    Optional title for the property.

    description?: string | null

    Human-readable description.

    minLength?: number | null

    Minimum string length.

    maxLength?: number | null

    Maximum string length.

    pattern?: string | null

    Pattern the string must match.

    format?: StringFormat | null

    String format.

    default?: string | null

    Default value.

    enum?: string[] | null

    Enum values for untitled single-select enums.

    oneOf?: EnumOption[] | null

    Titled enum options for titled single-select enums.

    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

    Settings

    Member Visibility

    On This Page

    Properties