[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>
This commit is contained in:
Alex Rothberg
GitHub
parent
bdc9d86671
commit
fc456125e2
1 changed files with 751 additions and 10 deletions
84
tests/Unit/Schema/Content/PromptMessageTest.php
Normal file
84
tests/Unit/Schema/Content/PromptMessageTest.php
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
<?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\Content;
|
||||
|
||||
use Mcp\Exception\InvalidArgumentException;
|
||||
use Mcp\Schema\Content\PromptMessage;
|
||||
use Mcp\Schema\Content\ResourceLink;
|
||||
use Mcp\Schema\Enum\Role;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
final class PromptMessageTest extends TestCase
|
||||
{
|
||||
public function testFromArrayDeserializesResourceLinkContent(): void
|
||||
{
|
||||
$message = PromptMessage::fromArray([
|
||||
'role' => 'user',
|
||||
'content' => [
|
||||
'type' => 'resource_link',
|
||||
'uri' => 'file:///project/src/main.rs',
|
||||
'name' => 'main.rs',
|
||||
],
|
||||
]);
|
||||
|
||||
$this->assertSame(Role::User, $message->role);
|
||||
$this->assertInstanceOf(ResourceLink::class, $message->content);
|
||||
$this->assertSame('file:///project/src/main.rs', $message->content->uri);
|
||||
$this->assertSame('main.rs', $message->content->name);
|
||||
}
|
||||
|
||||
public function testJsonSerializeIncludesResourceLinkContent(): void
|
||||
{
|
||||
$message = new PromptMessage(Role::Assistant, new ResourceLink('file:///a.png', 'a.png'));
|
||||
|
||||
$this->assertSame([
|
||||
'role' => 'assistant',
|
||||
'content' => [
|
||||
'type' => 'resource_link',
|
||||
'uri' => 'file:///a.png',
|
||||
'name' => 'a.png',
|
||||
],
|
||||
], json_decode(json_encode($message), true));
|
||||
}
|
||||
|
||||
public function testRoundTripWithResourceLink(): void
|
||||
{
|
||||
$original = new PromptMessage(Role::User, new ResourceLink('file:///a.png', 'a.png', mimeType: 'image/png'));
|
||||
|
||||
$decoded = json_decode(json_encode($original), true);
|
||||
$rehydrated = PromptMessage::fromArray($decoded);
|
||||
|
||||
$this->assertSame(Role::User, $rehydrated->role);
|
||||
$this->assertInstanceOf(ResourceLink::class, $rehydrated->content);
|
||||
$this->assertSame('file:///a.png', $rehydrated->content->uri);
|
||||
$this->assertSame('image/png', $rehydrated->content->mimeType);
|
||||
}
|
||||
|
||||
public function testFromArrayRejectsUnknownContentType(): void
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
|
||||
/* @phpstan-ignore argument.type */
|
||||
PromptMessage::fromArray([
|
||||
'role' => 'user',
|
||||
'content' => ['type' => 'not-a-real-type'],
|
||||
]);
|
||||
}
|
||||
|
||||
public function testConstructorAcceptsResourceLinkContent(): void
|
||||
{
|
||||
$link = new ResourceLink('file:///a.png', 'a.png');
|
||||
$message = new PromptMessage(Role::User, $link);
|
||||
|
||||
$this->assertSame($link, $message->content);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue