PromptResultFormatter
FinalYes
Tags
Table of Contents
Methods
- format() : array<string|int, PromptMessage>
- Formats the raw result of a prompt generator into an array of MCP PromptMessages.
- formatContent() : TextContent|ImageContent|AudioContent|ResourceLink|EmbeddedResource
- Formats content into a proper Content object.
- formatMessage() : PromptMessage
- Formats a single message into a PromptMessage.
- formatTypedContent() : TextContent|ImageContent|AudioContent|ResourceLink|EmbeddedResource
- Formats typed content arrays into Content objects.
Methods
format()
Formats the raw result of a prompt generator into an array of MCP PromptMessages.
public
format(mixed $promptGenerationResult) : array<string|int, PromptMessage>
Parameters
- $promptGenerationResult : mixed
-
expected: array of message structures
Tags
Return values
array<string|int, PromptMessage> —array of PromptMessage objects
formatContent()
Formats content into a proper Content object.
private
formatContent(mixed $content[, int|null $index = null ]) : TextContent|ImageContent|AudioContent|ResourceLink|EmbeddedResource
Parameters
- $content : mixed
- $index : int|null = null
Return values
TextContent|ImageContent|AudioContent|ResourceLink|EmbeddedResourceformatMessage()
Formats a single message into a PromptMessage.
private
formatMessage(mixed $message[, int|null $index = null ]) : PromptMessage
Parameters
- $message : mixed
- $index : int|null = null
Return values
PromptMessageformatTypedContent()
Formats typed content arrays into Content objects.
private
formatTypedContent(array<string, mixed> $content[, int|null $index = null ]) : TextContent|ImageContent|AudioContent|ResourceLink|EmbeddedResource
Delegates to the schema classes' fromArray() so optional fields (annotations, mimeType, _meta, ...) carry over instead of being dropped.
Parameters
- $content : array<string, mixed>
- $index : int|null = null