OzMcp.Structs.NumberSchema (OzMcp v0.9.0)

Copy Markdown View Source

Helper module used to build NumberSchema structure: a numeric field of an elicitation form. The type is number by default; use type/2 with :integer for a whole number.

(MCP protocol: 2025-11-25)

Short example:

%NumberSchema{}
  |> NumberSchema.type(:integer)
  |> NumberSchema.minimum(1)
  |> NumberSchema.maximum(10)
  |> NumberSchema.build()

Result:

%{type: "integer", minimum: 1, maximum: 10}

Specification: NumberSchema

Fields

FieldSetterTypeRequired
typetype/2:number, :integer, "number", "integer"yes
titletitle/2stringno
descriptiondescription/2stringno
minimumminimum/2numberno
maximummaximum/2numberno
defaultdefault/2numberno

Summary

Types

t()

@type t() :: %OzMcp.Structs.NumberSchema{
  default: number() | nil,
  description: String.t() | nil,
  maximum: number() | nil,
  minimum: number() | nil,
  title: String.t() | nil,
  type: term()
}

Functions

build(struct)

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

default(struct, value)

@spec default(t(), number() | nil) :: t()

description(struct, value)

@spec description(t(), String.t() | nil) :: t()

maximum(struct, value)

@spec maximum(t(), number() | nil) :: t()

minimum(struct, value)

@spec minimum(t(), number() | nil) :: t()

title(struct, value)

@spec title(t(), String.t() | nil) :: t()

type(struct, value)

@spec type(t(), term()) :: t()