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

Helper module used to build the params of an `elicitation/create` request
in form mode.

_(MCP protocol: 2025-11-25)_

`requestedSchema` is a `OzMcp.Structs.ElicitationSchema` struct or a map
that is already a schema.

## Short example:

```elixir
%ElicitRequestFormParams{}
  |> ElicitRequestFormParams.message("Which name?")
  |> ElicitRequestFormParams.requested_schema(schema)
  |> ElicitRequestFormParams.build()
```

Result:

```elixir
%{mode: "form", message: "Which name?", requestedSchema: %{type: "object", ...}}
```

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

## Fields

| Field | Setter | Type | Required |
|---|---|---|---|
| `message` | `message/2` | string | yes |
| `requestedSchema` | `requested_schema/2` | OzMcp.Structs.ElicitationSchema.t() \| map() \| nil | yes |
| `_meta` | `_meta/2` | map | no |
| `task` | `task/2` | `t:OzMcp.Structs.TaskMetadata.t/0` | no |

# `t`

```elixir
@type t() :: %OzMcp.Structs.ElicitRequestFormParams{
  _meta: map() | nil,
  message: String.t(),
  requestedSchema: OzMcp.Structs.ElicitationSchema.t() | map() | nil,
  task: OzMcp.Structs.TaskMetadata.t() | nil
}
```

# `build`

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

# `message`

```elixir
@spec message(t(), String.t()) :: t()
```

# `requested_schema`

```elixir
@spec requested_schema(t(), OzMcp.Structs.ElicitationSchema.t() | map() | nil) :: t()
```

# `task`

```elixir
@spec task(t(), OzMcp.Structs.TaskMetadata.t() | nil) :: t()
```

---

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