FastestMCP.Prompts.Result (fastest_mcp v0.1.2)

Copy Markdown View Source

Canonical prompt result helper.

FastestMCP.Prompts.Result gives prompt handlers one explicit return type when they need multiple messages, custom roles, or result-level metadata.

Accepted message inputs:

Bare single-message structs are rejected on purpose. Use a list to make the cardinality explicit.

Examples

FastestMCP.Prompts.Result.new("Hello")

FastestMCP.Prompts.Result.new([
  FastestMCP.Prompts.Message.new("Review this diff"),
  FastestMCP.Prompts.Message.new("I can do that.", role: :assistant)
], description: "Code review prompt")

Summary

Functions

Normalizes prompt-result input into %FastestMCP.Prompts.Result{}.

Builds a normalized prompt result.

Types

t()

@type t() :: %FastestMCP.Prompts.Result{
  description: String.t() | nil,
  messages: [FastestMCP.Prompts.Message.t()],
  meta: map() | nil
}

Functions

from(result)

Normalizes prompt-result input into %FastestMCP.Prompts.Result{}.

new(messages, opts \\ [])

Builds a normalized prompt result.

to_map(result)