OzMcp.Structs.Task (OzMcp v0.9.0)

Copy Markdown View Source

Helper module used to build Task structure.

(MCP protocol: 2025-11-25)

Short example:

%Task{}
  |> Task.task_id("task-123")
  |> Task.status(:working)
  |> Task.created_at("2025-01-12T15:00:58Z")
  |> Task.last_updated_at("2025-01-12T15:01:12Z")
  |> Task.ttl(60_000)
  |> Task.build()

Result:

%{
  status: "working",
  ttl: 60000,
  taskId: "task-123",
  createdAt: "2025-01-12T15:00:58Z",
  lastUpdatedAt: "2025-01-12T15:01:12Z"
}

Specification: Task

Fields

FieldSetterTypeRequired
taskIdtask_id/2stringyes
statusstatus/2status()yes
statusMessagestatus_message/2stringno
createdAtcreated_at/2stringyes
lastUpdatedAtlast_updated_at/2stringyes
ttlttl/2non-negative integerno
pollIntervalpoll_interval/2non-negative integerno

Summary

Types

status()

@type status() :: :working | :input_required | :completed | :failed | :cancelled

t()

@type t() :: %OzMcp.Structs.Task{
  createdAt: String.t(),
  lastUpdatedAt: String.t(),
  pollInterval: non_neg_integer() | nil,
  status: status(),
  statusMessage: String.t() | nil,
  taskId: String.t(),
  ttl: non_neg_integer() | nil
}

Functions

build(struct)

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

created_at(struct, value)

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

last_updated_at(struct, value)

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

poll_interval(struct, value)

@spec poll_interval(t(), non_neg_integer() | nil) :: t()

status(struct, value)

@spec status(t(), status()) :: t()

status_message(struct, value)

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

task_id(struct, value)

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

ttl(struct, value)

@spec ttl(t(), non_neg_integer() | nil) :: t()