FastestMCP.Interact (fastest_mcp v0.1.2)

Copy Markdown View Source

Friendly interaction helpers built on top of FastestMCP.Context.

The helpers keep the transport and task semantics in Context, while exposing an Elixir-native API for common prompts:

case FastestMCP.Interact.confirm(ctx, "Proceed?") do
  {:ok, true} -> :approved
  {:ok, false} -> :rejected
  :declined -> :declined
  :cancelled -> :cancelled
end

Summary

Functions

Requests an approval response.

Selects one option from an elicitation result.

Requests a confirmation response.

Requests a structured form response.

Runs a sampling request from this context.

Extracts or requests plain text for this interaction.

Types

interaction_result(value)

@type interaction_result(value) :: {:ok, value} | :declined | :cancelled

Functions

approve(context, message, opts \\ [])

Requests an approval response.

choose(context, message, choices, opts \\ [])

Selects one option from an elicitation result.

confirm(context, message, opts \\ [])

Requests a confirmation response.

form(context, message, schema_or_fields, opts \\ [])

Requests a structured form response.

sample(context, prompt_or_messages, opts \\ [])

Runs a sampling request from this context.

text(context, message, opts \\ [])

Extracts or requests plain text for this interaction.