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:
%ElicitRequestFormParams{}
|> ElicitRequestFormParams.message("Which name?")
|> ElicitRequestFormParams.requested_schema(schema)
|> ElicitRequestFormParams.build()Result:
%{mode: "form", message: "Which name?", requestedSchema: %{type: "object", ...}}Specification: 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 | OzMcp.Structs.TaskMetadata.t/0 | no |
Summary
Types
@type t() :: %OzMcp.Structs.ElicitRequestFormParams{ _meta: map() | nil, message: String.t(), requestedSchema: OzMcp.Structs.ElicitationSchema.t() | map() | nil, task: OzMcp.Structs.TaskMetadata.t() | nil }