php-sdk/tests/Unit/Server/RequestContextTest.php
Christopher Hertel becce29c41
[Capability] Harden structuredContent extraction (#417)
* Address review feedback on resource_link

Three follow-ups from review of the resource_link work:

* PromptResultFormatter: add a regression test proving the optional
  fields of a typed resource_link block (title, description, mimeType,
  size, annotations, _meta) survive formatting. The delegation to
  ResourceLink::fromArray() already landed while rebasing onto the
  PromptResultFormatter refactor, but the existing test only supplied
  uri/name and so could not catch a reintroduced field drop.

* ResourceLink::fromArray(): validate optional fields consistently, the
  way the equivalent ResourceDefinition::fromArray() already does.
  description, mimeType and size now raise InvalidArgumentException
  instead of surfacing a TypeError (or silently coercing, for size's
  (int) cast); annotations goes through Annotations::tryFromArray(),
  which carries the is_array() guard that icons already had; icons uses
  Icon::listFromArray() so a non-array entry is reported in context.

* ToolReference::extractStructuredContent(): never emit a list as
  structuredContent. The Content guard added earlier fixed only one
  instance of the real invariant - structuredContent must be a JSON
  object, and a PHP list can never be one. Tool::fromArray() already
  enforces the matching rule by rejecting an outputSchema whose type is
  not "object", so this aligns the runtime path with it. The test
  asserting the opposite for an array-typed outputSchema contradicted
  the phpstan type and the fromArray() check introduced alongside it in
  the same commit, so it is replaced by tests for the two list shapes.

* Apply the structuredContent object rule to object results too

`extractStructuredContent()` guards raw array results against being emitted
as a JSON array, but the object branch handed back whatever `json_decode()`
produced. A `JsonSerializable` returning a list or a scalar slipped straight
through, producing exactly the `structuredContent` the array guard exists to
prevent — and a return value that contradicts the method's own
`array<string, mixed>|null` signature.

Check the decoded value before returning it, and cover the object branch,
which had no tests at all.

* Document structured tool output

`outputSchema` and `structuredContent` were undocumented: the tool return
value docs covered only the `content` side, and the schema generation
section is about tool parameters.

Add a "Structured Output" subsection covering how to declare the schema,
which return values populate `structuredContent`, and why a list has to be
wrapped in a key to get structured output at all.

* Gate structuredContent on the negotiated protocol revision

SEP-2106 (revision 2026-07-28) widens structuredContent to any JSON value;
earlier revisions require an object. Resolve the revision per request and
apply the matching rule, and warn when a declared outputSchema yields none.

* Resolve the protocol revision on RequestContext

Keeps the `_meta`-then-session lookup in one place instead of per handler,
and exposes the negotiated revision to tool handlers.

* Document reading the negotiated revision from RequestContext

* Warn when a self-built CallToolResult carries an invalid structuredContent

Returning a CallToolResult opts out of the extraction rules, so the value is
still sent unchanged — but a JSON array is not valid before SEP-2106.
2026-08-15 04:03:20 +02:00

89 lines
2.7 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\Server;
use Mcp\Schema\Enum\ProtocolVersion;
use Mcp\Schema\Request\CallToolRequest;
use Mcp\Server\RequestContext;
use Mcp\Server\Session\SessionInterface;
use PHPUnit\Framework\TestCase;
class RequestContextTest extends TestCase
{
public function testProtocolVersionComesFromTheSessionInTheHandshakeEra(): void
{
$context = new RequestContext(
$this->createSession('2025-06-18'),
$this->createRequest(),
);
$this->assertSame(ProtocolVersion::V2025_06_18, $context->getProtocolVersion());
}
public function testPerRequestMetaTakesPrecedenceOverTheSession(): void
{
// Modern revisions have no `initialize`, so the revision travels with every
// single request instead of being negotiated once.
$context = new RequestContext(
$this->createSession('2025-11-25'),
$this->createRequest(['io.modelcontextprotocol/protocolVersion' => '2026-07-28']),
);
$this->assertSame(ProtocolVersion::V2026_07_28, $context->getProtocolVersion());
}
/**
* @dataProvider provideUnusableVersions
*/
public function testUnusableVersionFallsBackToTheNewestHandshakeRevision(mixed $stored): void
{
$context = new RequestContext(
$this->createSession($stored),
$this->createRequest(),
);
$this->assertSame(ProtocolVersion::latestHandshake(), $context->getProtocolVersion());
}
/**
* @return iterable<string, array{mixed}>
*/
public static function provideUnusableVersions(): iterable
{
yield 'never negotiated' => [null];
yield 'unknown revision' => ['1999-01-01'];
yield 'not a string' => [20260728];
}
private function createSession(mixed $protocolVersion): SessionInterface
{
$session = $this->createMock(SessionInterface::class);
$session->method('get')->with('protocol_version')->willReturn($protocolVersion);
return $session;
}
/**
* @param array<string, mixed>|null $meta
*/
private function createRequest(?array $meta = null): CallToolRequest
{
$request = CallToolRequest::fromArray([
'jsonrpc' => '2.0',
'method' => CallToolRequest::getMethod(),
'id' => 'test-request',
'params' => ['name' => 'test_tool', 'arguments' => []],
]);
return null === $meta ? $request : $request->withMeta($meta);
}
}