OzMcp.Structs.ElicitationSchema (OzMcp v0.9.0)

Copy Markdown View Source

Helper module used to build the requestedSchema of a form elicitation: a flat object whose properties are primitive fields.

(MCP protocol: 2025-11-25)

A property is one of OzMcp.Structs.StringSchema, OzMcp.Structs.NumberSchema, OzMcp.Structs.BooleanSchema, OzMcp.Structs.EnumSchema, OzMcp.Structs.MultiSelectEnumSchema, or a map that is already a primitive schema. The form is flat: build/1 raises ArgumentError for a map whose type is not string, number, integer, boolean or an array of strings (a nested object, or an array of objects).

Short example:

%ElicitationSchema{}
  |> ElicitationSchema.property("name", %StringSchema{} |> StringSchema.title("Name"))
  |> ElicitationSchema.property("age", %NumberSchema{} |> NumberSchema.type(:integer))
  |> ElicitationSchema.required(["name"])
  |> ElicitationSchema.build()

Result:

%{
  type: "object",
  properties: %{
    "name" => %{type: "string", title: "Name"},
    "age" => %{type: "integer"}
  },
  required: ["name"]
}

Specification: ElicitRequestFormParams

Fields

FieldSetterTypeRequired
propertiesproperties/2%{optional(String.t()) => primitive()}yes
requiredrequired/2list(String.t()) | nilno

Summary

Types

primitive()

@type primitive() ::
  %OzMcp.Structs.StringSchema{
    default: term(),
    description: term(),
    format: term(),
    maxLength: term(),
    minLength: term(),
    title: term()
  }
  | %OzMcp.Structs.NumberSchema{
      default: term(),
      description: term(),
      maximum: term(),
      minimum: term(),
      title: term(),
      type: term()
    }
  | %OzMcp.Structs.BooleanSchema{
      default: term(),
      description: term(),
      title: term()
    }
  | %OzMcp.Structs.EnumSchema{
      default: term(),
      description: term(),
      options: term(),
      title: term()
    }
  | %OzMcp.Structs.MultiSelectEnumSchema{
      default: term(),
      description: term(),
      maxItems: term(),
      minItems: term(),
      options: term(),
      title: term()
    }
  | map()

t()

@type t() :: %OzMcp.Structs.ElicitationSchema{
  properties: %{optional(String.t()) => primitive()},
  required: [String.t()] | nil
}

Functions

build(struct)

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

properties(struct, value)

@spec properties(t(), %{optional(String.t()) => primitive()}) :: t()

property(struct, name, schema)

@spec property(
  %OzMcp.Structs.ElicitationSchema{properties: term(), required: term()},
  String.t(),
  primitive()
) :: %OzMcp.Structs.ElicitationSchema{properties: term(), required: term()}

required(struct, value)

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