Agent Client Protocol - v1.4.0
    Preparing search index...

    Type Alias ElicitationSchema

    Type-safe elicitation schema for requesting structured user input.

    This represents a JSON Schema object with primitive-typed properties, as required by the elicitation specification.

    type ElicitationSchema = {
        type?: ElicitationSchemaType;
        title?: string | null;
        properties?: { [key: string]: ElicitationPropertySchema };
        required?: string[] | null;
        description?: string | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    type? title? properties? required? description? _meta?
    type?: ElicitationSchemaType

    Type discriminator. Always "object".

    title?: string | null

    Optional title for the schema.

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

    properties?: { [key: string]: ElicitationPropertySchema }

    Property definitions (must be primitive types).

    required?: string[] | null

    List of required property names.

    Optional. Omitted and null are equivalent and mean no property names are required.

    description?: string | null

    Optional description of what this schema represents.

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

    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