OzMcp.Structs.MultiSelectEnumSchema (OzMcp v0.9.0)

Copy Markdown View Source

Helper module used to build a multi-select enum field of an elicitation form (UntitledMultiSelectEnumSchema or TitledMultiSelectEnumSchema).

(MCP protocol: 2025-11-25)

The options are the same as for OzMcp.Structs.EnumSchema. Without titles the items use enum; with at least one title they use anyOf.

Short example:

%MultiSelectEnumSchema{}
  |> MultiSelectEnumSchema.options(["a", "b", "c"])
  |> MultiSelectEnumSchema.min_items(1)
  |> MultiSelectEnumSchema.default(["a"])
  |> MultiSelectEnumSchema.build()

Result:

%{type: "array", items: %{type: "string", enum: ["a", "b", "c"]}, minItems: 1, default: ["a"]}

Specification: EnumSchema

Fields

FieldSetterTypeRequired
titletitle/2stringno
descriptiondescription/2stringno
optionsoptions/2list(OzMcp.Structs.EnumOptions.option())no
minItemsmin_items/2non-negative integerno
maxItemsmax_items/2non-negative integerno
defaultdefault/2list(String.t()) | nilno

Summary

Types

t()

@type t() :: %OzMcp.Structs.MultiSelectEnumSchema{
  default: [String.t()] | nil,
  description: String.t() | nil,
  maxItems: non_neg_integer() | nil,
  minItems: non_neg_integer() | nil,
  options: [OzMcp.Structs.EnumOptions.option()],
  title: String.t() | nil
}

Functions

build(struct)

@spec build(t()) :: map()

default(struct, value)

@spec default(t(), [String.t()] | nil) :: t()

description(struct, value)

@spec description(t(), String.t() | nil) :: t()

max_items(struct, value)

@spec max_items(t(), non_neg_integer() | nil) :: t()

min_items(struct, value)

@spec min_items(t(), non_neg_integer() | nil) :: t()

options(struct, value)

@spec options(t(), [OzMcp.Structs.EnumOptions.option()]) :: t()

title(struct, value)

@spec title(t(), String.t() | nil) :: t()