# `OzMcp.Structs.ElicitationSchema`
[🔗](https://github.com/oz-elixir/oz_mcp/blob/v0.9.0/lib/oz_mcp/structs/elicitation_schema.ex#L1)

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:

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

Result:

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

Specification: [ElicitRequestFormParams](https://modelcontextprotocol.io/specification/2025-11-25/schema#elicitrequestformparams)

## Fields

| Field | Setter | Type | Required |
|---|---|---|---|
| `properties` | `properties/2` | %{optional(String.t()) => primitive()} | yes |
| `required` | `required/2` | list(String.t()) \| nil | no |

# `primitive`

```elixir
@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`

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

# `build`

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

# `properties`

```elixir
@spec properties(t(), %{optional(String.t()) =&gt; primitive()}) :: t()
```

# `property`

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

# `required`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*
