Agent Client Protocol - v0.18.2
    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 = {
        default?: string | null;
        description?: string | null;
        enum?: string[] | null;
        format?: StringFormat | null;
        maxLength?: number | null;
        minLength?: number | null;
        oneOf?: EnumOption[] | null;
        pattern?: string | null;
        title?: string | null;
    }
    Index

    Properties

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

    Properties

    default?: string | null

    Default value.

    description?: string | null

    Human-readable description.

    enum?: string[] | null

    Enum values for untitled single-select enums.

    format?: StringFormat | null

    String format.

    maxLength?: number | null

    Maximum string length.

    minLength?: number | null

    Minimum string length.

    oneOf?: EnumOption[] | null

    Titled enum options for titled single-select enums.

    pattern?: string | null

    Pattern the string must match.

    title?: string | null

    Optional title for the property.

    Settings

    Member Visibility

    On This Page

    Properties