ab4f686e18Split formatting logic from Reference classes into dedicated formatter classes: - ToolResultFormatter: Formats tool execution results into Content items - PromptResultFormatter: Formats prompt results into PromptMessage items - ResourceResultFormatter: Formats resource results into ResourceContents items This refactor: - Eliminates 122 lines of code duplication between ResourceReference and ResourceTemplateReference (identical formatting logic) - Improves code organization by separating formatting concerns from capability reference management - Makes formatters independently testable and reusable - Reduces Reference classes by ~450 lines while maintaining all functionality Changes: - Create src/Capability/Formatter/* with three formatter classes - Update Reference classes to delegate to formatters instead of inline logic - Add comprehensive test coverage for all formatter classes - All existing tests pass; no behavioral changes
267 lines
10 KiB
PHP
267 lines
10 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the official PHP MCP SDK.
|
|
*
|
|
* A collaboration between Symfony and the PHP Foundation.
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Mcp\Capability\Formatter;
|
|
|
|
use Mcp\Exception\RuntimeException;
|
|
use Mcp\Schema\Content\AudioContent;
|
|
use Mcp\Schema\Content\BlobResourceContents;
|
|
use Mcp\Schema\Content\Content;
|
|
use Mcp\Schema\Content\EmbeddedResource;
|
|
use Mcp\Schema\Content\ImageContent;
|
|
use Mcp\Schema\Content\PromptMessage;
|
|
use Mcp\Schema\Content\TextContent;
|
|
use Mcp\Schema\Content\TextResourceContents;
|
|
use Mcp\Schema\Enum\Role;
|
|
|
|
/**
|
|
* @author Kyrian Obikwelu <koshnawaza@gmail.com>
|
|
* @author Mateu Aguiló Bosch <mateu@mateuaguilo.com>
|
|
*/
|
|
final class PromptResultFormatter
|
|
{
|
|
/**
|
|
* Formats the raw result of a prompt generator into an array of MCP PromptMessages.
|
|
*
|
|
* @param mixed $promptGenerationResult expected: array of message structures
|
|
*
|
|
* @return PromptMessage[] array of PromptMessage objects
|
|
*
|
|
* @throws \RuntimeException if the result cannot be formatted
|
|
* @throws \JsonException if JSON encoding fails
|
|
*/
|
|
public function format(mixed $promptGenerationResult): array
|
|
{
|
|
if ($promptGenerationResult instanceof PromptMessage) {
|
|
return [$promptGenerationResult];
|
|
}
|
|
|
|
if (!\is_array($promptGenerationResult)) {
|
|
throw new RuntimeException('Prompt generator method must return an array of messages.');
|
|
}
|
|
|
|
if (empty($promptGenerationResult)) {
|
|
return [];
|
|
}
|
|
|
|
if (\is_array($promptGenerationResult)) {
|
|
$allArePromptMessages = true;
|
|
$hasPromptMessages = false;
|
|
|
|
foreach ($promptGenerationResult as $item) {
|
|
if ($item instanceof PromptMessage) {
|
|
$hasPromptMessages = true;
|
|
} else {
|
|
$allArePromptMessages = false;
|
|
}
|
|
}
|
|
|
|
if ($allArePromptMessages && $hasPromptMessages) {
|
|
return $promptGenerationResult;
|
|
}
|
|
|
|
if ($hasPromptMessages) {
|
|
$result = [];
|
|
foreach ($promptGenerationResult as $index => $item) {
|
|
if ($item instanceof PromptMessage) {
|
|
$result[] = $item;
|
|
} else {
|
|
$result = array_merge($result, $this->format($item));
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
if (!array_is_list($promptGenerationResult)) {
|
|
if (isset($promptGenerationResult['user']) || isset($promptGenerationResult['assistant'])) {
|
|
$result = [];
|
|
if (isset($promptGenerationResult['user'])) {
|
|
$userContent = $this->formatContent($promptGenerationResult['user']);
|
|
$result[] = new PromptMessage(Role::User, $userContent);
|
|
}
|
|
if (isset($promptGenerationResult['assistant'])) {
|
|
$assistantContent = $this->formatContent($promptGenerationResult['assistant']);
|
|
$result[] = new PromptMessage(Role::Assistant, $assistantContent);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
if (isset($promptGenerationResult['role']) && isset($promptGenerationResult['content'])) {
|
|
return [$this->formatMessage($promptGenerationResult)];
|
|
}
|
|
|
|
throw new RuntimeException('Associative array must contain either role/content keys or user/assistant keys.');
|
|
}
|
|
|
|
$formattedMessages = [];
|
|
foreach ($promptGenerationResult as $index => $message) {
|
|
if ($message instanceof PromptMessage) {
|
|
$formattedMessages[] = $message;
|
|
} else {
|
|
$formattedMessages[] = $this->formatMessage($message, $index);
|
|
}
|
|
}
|
|
|
|
return $formattedMessages;
|
|
}
|
|
|
|
throw new RuntimeException('Invalid prompt generation result format.');
|
|
}
|
|
|
|
/**
|
|
* Formats a single message into a PromptMessage.
|
|
*/
|
|
private function formatMessage(mixed $message, ?int $index = null): PromptMessage
|
|
{
|
|
$indexStr = null !== $index ? " at index {$index}" : '';
|
|
|
|
if (!\is_array($message) || !\array_key_exists('role', $message) || !\array_key_exists('content', $message)) {
|
|
throw new RuntimeException("Invalid message format{$indexStr}. Expected an array with 'role' and 'content' keys.");
|
|
}
|
|
|
|
$role = $message['role'] instanceof Role ? $message['role'] : Role::tryFrom($message['role']);
|
|
if (null === $role) {
|
|
throw new RuntimeException("Invalid role '{$message['role']}' in prompt message{$indexStr}. Only 'user' or 'assistant' are supported.");
|
|
}
|
|
|
|
$content = $this->formatContent($message['content'], $index);
|
|
|
|
return new PromptMessage($role, $content);
|
|
}
|
|
|
|
/**
|
|
* Formats content into a proper Content object.
|
|
*/
|
|
private function formatContent(mixed $content, ?int $index = null): TextContent|ImageContent|AudioContent|EmbeddedResource
|
|
{
|
|
$indexStr = null !== $index ? " at index {$index}" : '';
|
|
|
|
if ($content instanceof Content) {
|
|
if (
|
|
$content instanceof TextContent || $content instanceof ImageContent
|
|
|| $content instanceof AudioContent || $content instanceof EmbeddedResource
|
|
) {
|
|
return $content;
|
|
}
|
|
throw new RuntimeException("Invalid Content type{$indexStr}. PromptMessage only supports TextContent, ImageContent, AudioContent, or EmbeddedResource.");
|
|
}
|
|
|
|
if (\is_string($content)) {
|
|
return new TextContent($content);
|
|
}
|
|
|
|
if (\is_array($content) && isset($content['type'])) {
|
|
return $this->formatTypedContent($content, $index);
|
|
}
|
|
|
|
if (\is_scalar($content) || null === $content) {
|
|
$stringContent = null === $content ? '(null)' : (\is_bool($content) ? ($content ? 'true' : 'false') : (string) $content);
|
|
|
|
return new TextContent($stringContent);
|
|
}
|
|
|
|
$jsonContent = json_encode($content, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE | \JSON_THROW_ON_ERROR);
|
|
|
|
return new TextContent($jsonContent);
|
|
}
|
|
|
|
/**
|
|
* Formats typed content arrays into Content objects.
|
|
*
|
|
* @param array<string, mixed> $content
|
|
*/
|
|
private function formatTypedContent(array $content, ?int $index = null): TextContent|ImageContent|AudioContent|EmbeddedResource
|
|
{
|
|
$indexStr = null !== $index ? " at index {$index}" : '';
|
|
$type = $content['type'];
|
|
|
|
return match ($type) {
|
|
'text' => $this->formatTextContent($content, $indexStr),
|
|
'image' => $this->formatImageContent($content, $indexStr),
|
|
'audio' => $this->formatAudioContent($content, $indexStr),
|
|
'resource' => $this->formatResourceContent($content, $indexStr),
|
|
default => throw new RuntimeException("Invalid content type '{$type}'{$indexStr}."),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $content
|
|
*/
|
|
private function formatTextContent(array $content, string $indexStr): TextContent
|
|
{
|
|
if (!isset($content['text']) || !\is_string($content['text'])) {
|
|
throw new RuntimeException(\sprintf('Invalid "text" content%s: Missing or invalid "text" string.', $indexStr));
|
|
}
|
|
|
|
return new TextContent($content['text']);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $content
|
|
*/
|
|
private function formatImageContent(array $content, string $indexStr): ImageContent
|
|
{
|
|
if (!isset($content['data']) || !\is_string($content['data'])) {
|
|
throw new RuntimeException("Invalid 'image' content{$indexStr}: Missing or invalid 'data' string (base64).");
|
|
}
|
|
if (!isset($content['mimeType']) || !\is_string($content['mimeType'])) {
|
|
throw new RuntimeException("Invalid 'image' content{$indexStr}: Missing or invalid 'mimeType' string.");
|
|
}
|
|
|
|
return new ImageContent($content['data'], $content['mimeType']);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $content
|
|
*/
|
|
private function formatAudioContent(array $content, string $indexStr): AudioContent
|
|
{
|
|
if (!isset($content['data']) || !\is_string($content['data'])) {
|
|
throw new RuntimeException("Invalid 'audio' content{$indexStr}: Missing or invalid 'data' string (base64).");
|
|
}
|
|
if (!isset($content['mimeType']) || !\is_string($content['mimeType'])) {
|
|
throw new RuntimeException("Invalid 'audio' content{$indexStr}: Missing or invalid 'mimeType' string.");
|
|
}
|
|
|
|
return new AudioContent($content['data'], $content['mimeType']);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $content
|
|
*/
|
|
private function formatResourceContent(array $content, string $indexStr): EmbeddedResource
|
|
{
|
|
if (!isset($content['resource']) || !\is_array($content['resource'])) {
|
|
throw new RuntimeException("Invalid 'resource' content{$indexStr}: Missing or invalid 'resource' object.");
|
|
}
|
|
|
|
$resource = $content['resource'];
|
|
if (!isset($resource['uri']) || !\is_string($resource['uri'])) {
|
|
throw new RuntimeException("Invalid resource{$indexStr}: Missing or invalid 'uri'.");
|
|
}
|
|
|
|
if (isset($resource['text']) && \is_string($resource['text'])) {
|
|
$resourceObj = new TextResourceContents($resource['uri'], $resource['mimeType'] ?? 'text/plain', $resource['text']);
|
|
} elseif (isset($resource['blob']) && \is_string($resource['blob'])) {
|
|
$resourceObj = new BlobResourceContents(
|
|
$resource['uri'],
|
|
$resource['mimeType'] ?? 'application/octet-stream',
|
|
$resource['blob']
|
|
);
|
|
} else {
|
|
throw new RuntimeException("Invalid resource{$indexStr}: Must contain 'text' or 'blob'.");
|
|
}
|
|
|
|
return new EmbeddedResource($resourceObj);
|
|
}
|
|
}
|