php-sdk/tests/Unit/Schema/Result/CallToolResultTest.php
Alex Rothberg fc456125e2
[Schema] Add resource_link content block (#400)
* Add resource_link content block

The spec's `resource_link` content type (protocol revision 2025-06-18,
still present in 2025-11-25) had no corresponding schema class: it lets a
tool result or prompt message reference a resource by URI/name without
embedding its full contents, the way `EmbeddedResource` does. Without it,
tools returning many or large resource references (e.g. search results
over a DAM) are stuck smuggling URIs through text/structured content.

Add `Mcp\Schema\Content\ResourceLink`, mirroring the spec's `Resource`
shape (uri, name, title, description, mimeType, annotations, size, icons,
_meta) with a fixed `type: "resource_link"`, following the conventions of
the sibling `EmbeddedResource`/`ResourceDefinition` classes.

Register it everywhere `resource` content blocks are (de)serialized by
type per the spec's `ContentBlock` union:
- `CallToolResult::fromArray()`
- `PromptMessage` (constructor type, `fromArray()`, phpstan types)
- `PromptResultFormatter` (typed-array and direct-instance paths)

`SamplingMessage`/`CreateSamplingMessageResult` are intentionally left
unchanged: the spec's `SamplingMessageContentBlock` does not include
`ResourceLink`.

Fixes #399

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

* Add resource_link example coverage to discovery-userprofile

Add a lookup_user tool to the discovery-userprofile example: given a
userId, it returns a short text summary plus a resource_link pointing
at the existing user://{userId}/profile resource template, instead of
embedding the profile. This mirrors the PR's motivating use case (a
tool referencing many/large resources by URI rather than inlining
them) and exercises resource_link through the example's own inspector
snapshot tests (tools_call-lookup_user[_not_found], tools_list).

Wiring this up surfaced a real bug: ToolReference::extractStructuredContent()
passed any raw array return value straight through as structuredContent,
even when it held Content instances (e.g. the TextContent/ResourceLink
pair above). That serializes to a JSON list, which fails the spec's
requirement that structuredContent be an object - the inspector's MCP
client rejected the tool call outright until fixed. Skip structuredContent
extraction whenever the raw result contains a Content item, since those
are already represented in `content` and were never meant to double as
structured data.

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

---------

Co-authored-by: Alex Rothberg <51059+cancan101@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-14 23:20:56 +02:00

112 lines
4.1 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\Tests\Unit\Schema\Result;
use Mcp\Exception\InvalidArgumentException;
use Mcp\Schema\Content\AudioContent;
use Mcp\Schema\Content\EmbeddedResource;
use Mcp\Schema\Content\ImageContent;
use Mcp\Schema\Content\ResourceLink;
use Mcp\Schema\Content\TextContent;
use Mcp\Schema\Result\CallToolResult;
use PHPUnit\Framework\TestCase;
final class CallToolResultTest extends TestCase
{
public function testFromArrayDeserializesResourceLinkContent(): void
{
$result = CallToolResult::fromArray([
'content' => [
[
'type' => 'resource_link',
'uri' => 'file:///project/src/main.rs',
'name' => 'main.rs',
'mimeType' => 'text/x-rust',
],
],
'isError' => false,
]);
$this->assertCount(1, $result->content);
$this->assertInstanceOf(ResourceLink::class, $result->content[0]);
$this->assertSame('file:///project/src/main.rs', $result->content[0]->uri);
$this->assertSame('main.rs', $result->content[0]->name);
$this->assertSame('text/x-rust', $result->content[0]->mimeType);
}
public function testFromArrayDeserializesMixedContentTypes(): void
{
$result = CallToolResult::fromArray([
'content' => [
['type' => 'text', 'text' => 'search results'],
['type' => 'resource_link', 'uri' => 'file:///a.png', 'name' => 'a.png'],
['type' => 'resource_link', 'uri' => 'file:///b.png', 'name' => 'b.png'],
],
]);
$this->assertCount(3, $result->content);
$this->assertInstanceOf(TextContent::class, $result->content[0]);
$this->assertInstanceOf(ResourceLink::class, $result->content[1]);
$this->assertInstanceOf(ResourceLink::class, $result->content[2]);
}
public function testFromArrayRejectsUnknownContentType(): void
{
$this->expectException(InvalidArgumentException::class);
CallToolResult::fromArray([
'content' => [
['type' => 'not-a-real-type'],
],
]);
}
public function testJsonSerializeIncludesResourceLinkContent(): void
{
$result = new CallToolResult([
new ResourceLink('file:///project/src/main.rs', 'main.rs'),
]);
$data = $result->jsonSerialize();
$this->assertSame([
'type' => 'resource_link',
'uri' => 'file:///project/src/main.rs',
'name' => 'main.rs',
], $data['content'][0]->jsonSerialize());
}
public function testRoundTripWithResourceLinkAlongsideOtherContentTypes(): void
{
$original = new CallToolResult([
new TextContent('25 results found'),
new ResourceLink('file:///a.png', 'a.png', mimeType: 'image/png'),
new ImageContent(base64_encode('binary'), 'image/png'),
new AudioContent(base64_encode('binary'), 'audio/mpeg'),
EmbeddedResource::fromText('file:///readme.txt', 'hello'),
]);
$decoded = json_decode(json_encode($original), true);
$rehydrated = CallToolResult::fromArray($decoded);
$this->assertCount(5, $rehydrated->content);
$this->assertInstanceOf(TextContent::class, $rehydrated->content[0]);
$this->assertInstanceOf(ResourceLink::class, $rehydrated->content[1]);
$this->assertInstanceOf(ImageContent::class, $rehydrated->content[2]);
$this->assertInstanceOf(AudioContent::class, $rehydrated->content[3]);
$this->assertInstanceOf(EmbeddedResource::class, $rehydrated->content[4]);
$this->assertSame('file:///a.png', $rehydrated->content[1]->uri);
$this->assertSame('a.png', $rehydrated->content[1]->name);
$this->assertSame('image/png', $rehydrated->content[1]->mimeType);
}
}