OzMcp.Structs.ElicitRequestFormParams (OzMcp v0.9.0)

Copy Markdown View Source

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

FieldSetterTypeRequired
messagemessage/2stringyes
requestedSchemarequested_schema/2OzMcp.Structs.ElicitationSchema.t() | map() | nilyes
_meta_meta/2mapno
tasktask/2OzMcp.Structs.TaskMetadata.t/0no

Summary

Types

t()

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

Functions

build(struct)

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

message(struct, value)

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

requested_schema(struct, value)

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

task(struct, value)

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