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
| Field | Setter | Type | Required |
|---|---|---|---|
properties | properties/2 | %{optional(String.t()) => primitive()} | yes |
required | required/2 | list(String.t()) | nil | no |
Summary
Types
@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()