pending — suspend and ask a human

Elixir · package toolnexus · SPEC §10

Not available in Elixir

Elixir ships no pending/1 producer — construct %ToolResult{metadata: %{pending: %Request{}}} directly. Only the reader, ToolResult.pending?/1, exists.

Return a Pending from a tool to park the run until someone answers.

What to use instead

Build the suspension shape by hand: return a %Toolnexus.ToolResult{} whose metadata map carries a :pending key holding a %Toolnexus.Request{id:, kind: "input", prompt:}. The id is the correlation key a resolver (:wait_for or Toolnexus.Agents.Runtime.resume/2) echoes back in its Answer, so generate one you can look up later (a UUID, a database primary key). The wire shape is byte-identical to what every other port’s pending/1 producer builds — only the convenience constructor is missing:

%Toolnexus.ToolResult{
  output: "Which environment?",
  is_error: true,
  metadata: %{pending: %Toolnexus.Request{id: "pnd-1", kind: "input", prompt: "Which environment?"}}
}

Toolnexus.ToolResult.pending?/1 reads it back — see Toolnexus.ToolResult for a full worked example, and :wait_for for the whole suspend/resolve/retry cycle.

See also

• Toolnexus.Client.create — The single hook where the host resolves a suspension — in-process prompt or durable queue, same contract.
• Toolnexus.Agents.Runtime.resume — The answer-carrying entry point: resume a parked run in a different process.