Agent Client Protocol - v1.4.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
    title? description? minLength? maxLength? pattern? format? default? enum? oneOf? _meta?
    title?: string | null

    Optional title for the property.

    Optional. Omitted and null are equivalent and mean no title is provided.

    description?: string | null

    Human-readable description.

    Optional. Omitted and null are equivalent and mean no description is provided.

    minLength?: number | null

    Minimum string length.

    Optional. Omitted and null are equivalent and mean there is no minimum length constraint.

    maxLength?: number | null

    Maximum string length.

    Optional. Omitted and null are equivalent and mean there is no maximum length constraint.

    pattern?: string | null

    Pattern the string must match.

    Optional. Omitted and null are equivalent and mean there is no pattern constraint.

    format?: StringFormat | null

    String format.

    Optional. Omitted and null are equivalent and mean there is no format constraint.

    default?: string | null

    Default value.

    Optional. Omitted and null are equivalent and mean no default value is provided.

    enum?: string[] | null

    Enum values for untitled single-select enums. Optional. Omitted and null are equivalent and mean no untitled single-select choices are declared by enum.

    oneOf?: EnumOption[] | null

    Titled enum options for titled single-select enums. Optional. Omitted and null are equivalent and mean no titled single-select choices are declared by oneOf.

    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.

    Optional. Omitted and null are equivalent and mean no metadata.

    See protocol docs: Extensibility

    Settings
    Member Visibility

    On This Page
    Properties