modelcontextprotocol/php-sdk
Watch
1
0
Fork
You've already forked php-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

[Capability] Preserve optional content fields in PromptResultFormatter (#406)

Browse source 
* Preserve optional content fields in PromptResultFormatter

The formatter's typed-content path rebuilt each Content object from only
its required fields, silently dropping everything else a prompt returned
(annotations on every type, _meta and explicit mimeType on embedded
resource contents). Delegate to the schema classes' fromArray() instead,
keeping the historical mimeType defaulting and RuntimeException-with-
index error contract.

ImageContent was the only content class without annotations support, so
it gains the same constructor/fromArray()/jsonSerialize() handling as
TextContent and AudioContent.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Reword CHANGELOG entry to be user-facing

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Christopher Hertel 2026-08-14 22:47:26 +02:00 • committed by GitHub
commit 8bae3c054e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 283 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

142
tests/Unit/Capability/Formatter/PromptResultFormatterTest.php
View file

@ -12,6 +12,10 @@
namespace Mcp\Tests\Unit\Capability\Formatter;
use Mcp\Capability\Formatter\PromptResultFormatter;
use Mcp\Exception\RuntimeException;
use Mcp\Schema\Content\AudioContent;
use Mcp\Schema\Content\EmbeddedResource;
use Mcp\Schema\Content\ImageContent;
use Mcp\Schema\Content\PromptMessage;
use Mcp\Schema\Content\TextContent;
use Mcp\Schema\Enum\Role;
@ -46,4 +50,142 @@ class PromptResultFormatterTest extends TestCase
$this->assertCount(1, $result);
$this->assertSame(Role::User, $result[0]->role);
}
public function testFormatTypedTextContentPreservesAnnotations(): void
{
$result = (new PromptResultFormatter())->format([
[
'role' => 'user',
'content' => [
'type' => 'text',
'text' => 'Hello',
'annotations' => ['audience' => ['user'], 'priority' => 0.5],
],
],
]);
$content = $result[0]->content;
$this->assertInstanceOf(TextContent::class, $content);
$this->assertSame('Hello', $content->text);
$this->assertNotNull($content->annotations);
$this->assertSame([Role::User], $content->annotations->audience);
$this->assertSame(0.5, $content->annotations->priority);
}
public function testFormatTypedImageContentPreservesAnnotations(): void
{
$result = (new PromptResultFormatter())->format([
[
'role' => 'user',
'content' => [
'type' => 'image',
'data' => base64_encode('binary'),
'mimeType' => 'image/png',
'annotations' => ['audience' => ['assistant']],
],
],
]);
$content = $result[0]->content;
$this->assertInstanceOf(ImageContent::class, $content);
$this->assertSame('image/png', $content->mimeType);
$this->assertNotNull($content->annotations);
$this->assertSame([Role::Assistant], $content->annotations->audience);
}
public function testFormatTypedAudioContentPreservesAnnotations(): void
{
$result = (new PromptResultFormatter())->format([
[
'role' => 'user',
'content' => [
'type' => 'audio',
'data' => base64_encode('binary'),
'mimeType' => 'audio/mpeg',
'annotations' => ['priority' => 1.0],
],
],
]);
$content = $result[0]->content;
$this->assertInstanceOf(AudioContent::class, $content);
$this->assertNotNull($content->annotations);
$this->assertSame(1.0, $content->annotations->priority);
}
public function testFormatTypedResourceContentPreservesOptionalFields(): void
{
$result = (new PromptResultFormatter())->format([
[
'role' => 'user',
'content' => [
'type' => 'resource',
'resource' => [
'uri' => 'file://data.json',
'mimeType' => 'application/json',
'text' => '{"key": "value"}',
'_meta' => ['origin' => 'test'],
],
'annotations' => ['audience' => ['user']],
],
],
]);
$content = $result[0]->content;
$this->assertInstanceOf(EmbeddedResource::class, $content);
$this->assertSame('application/json', $content->resource->mimeType);
$this->assertSame(['origin' => 'test'], $content->resource->meta);
$this->assertNotNull($content->annotations);
$this->assertSame([Role::User], $content->annotations->audience);
}
public function testFormatTypedTextResourceContentDefaultsMimeType(): void
{
$result = (new PromptResultFormatter())->format([
[
'role' => 'user',
'content' => [
'type' => 'resource',
'resource' => ['uri' => 'file://a.txt', 'text' => 'plain'],
],
],
]);
$this->assertSame('text/plain', $result[0]->content->resource->mimeType);
}
public function testFormatTypedBlobResourceContentDefaultsMimeType(): void
{
$result = (new PromptResultFormatter())->format([
[
'role' => 'user',
'content' => [
'type' => 'resource',
'resource' => ['uri' => 'file://a.bin', 'blob' => base64_encode('binary')],
],
],
]);
$this->assertSame('application/octet-stream', $result[0]->content->resource->mimeType);
}
public function testFormatTypedContentRejectsInvalidDataWithIndexContext(): void
{
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage("Invalid 'text' content at index 0");
(new PromptResultFormatter())->format([
['role' => 'user', 'content' => ['type' => 'text']],
]);
}
public function testFormatTypedContentRejectsUnknownType(): void
{
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage("Invalid content type 'video' at index 0.");
(new PromptResultFormatter())->format([
['role' => 'user', 'content' => ['type' => 'video']],
]);
}
}