php-sdk/tests/Unit/Schema/ImplementationTest.php
Christopher Hertel f84d8f5aa9
[Schema][Server] Close the 2025-11-25 schema gaps and add the 2026-07-28 surface (#421)
* [Schema][Server] Close the 2025-11-25 schema gaps and add the 2026-07-28 surface

Ports the type definitions this SDK still misses outside of sampling tool use,
which #409 and #420 already cover. Every addition is optional and defaults to
current behaviour, so a connection negotiated on an older revision is
unaffected.

From 2025-11-25, elicitation gains modes. ElicitationMode splits `form` —
build a form from the requested schema — from `url`, which sends the user out
of band and returns only the accept/decline/cancel outcome. That is why
requestedSchema becomes optional and `url` appears beside it.
ClientCapabilities learns the matching sub-capabilities, where an
`elicitation` naming no mode declares form, the only shape that existed
before. Icon gains `theme` from the same revision, and Implementation gains
the `title` BaseMetadata has carried since 2025-06-18.

From 2026-07-28, schemas loosen where the revision loosens them: SEP-2106
drops the object-only restriction, so Tool::outputSchema may describe any JSON
value and CallToolResult::structuredContent follows.

The same revision defines three error codes (-32020 header mismatch, -32021
missing required client capability, -32022 unsupported protocol version).
ProtocolVersionMiddleware switches to the last of them, so a rejected version
carries the supported set as structured data the client can retry from rather
than only as prose.

* [Schema] Reject what the 2026-07-28 types cannot represent

`Implementation::title` reached the typed constructor unchecked, so malformed
wire data raised a TypeError instead of InvalidArgumentException.

`ToolUseContent::input` accepted a list and serialized it as a JSON array,
where the protocol requires an object. The empty array stays exempt: it is
also an empty map and still emits `{}`.

`ToolChoice` and `ElicitRequest` read their mode with isset(), which is false
for an explicit null, so `{"mode": null}` silently became the default instead
of being rejected. Both use array_key_exists() now, letting the existing type
check refuse null.

* [Client][Server] Advertise the implementation title through both builders

`Implementation::title` could be parsed but never sent: neither
`Client\Builder::setClientInfo()` nor `Server\Builder::setServerInfo()`
accepted one, so every SDK user emitted null.

Both gain a trailing optional `$title`. On the server it sits where the
Implementation constructor already puts it, so existing positional calls keep
their meaning; the client builder forwards it by name, leaving the icons and
websiteUrl slots defaulted.

* [Schema] Serialize every non-null structuredContent

The object-only hydration guard was never that: `!is_array()` admitted
`[1, 2, 3]` and `[]`, which serialize to JSON arrays, while rejecting the
scalars 2026-07-28 permits. The truthiness emission gate was backwards in the
same way — it dropped `[]`, `0`, `false` and `""`, yet emitted lists, strings
and an empty stdClass.

Hydration now accepts any JSON value, and `null` alone means absent, matching
`ToolResultContent` which already carries this field that way. Which values a
given revision permits is a question for version-aware serialization, which
results cannot answer yet.

* [Schema][Server] Make url elicitation reachable

`ElicitRequest::forUrl()` built a request no SDK user could send: the only
public gateway method always constructed form mode from an ElicitationSchema,
and `request()` is private.

`elicitUrl()` joins `elicit()`, and both funnel through one send path that
hydrates the result with the request's own mode. Without that, a url-mode
accept — contentless by design — threw, because ElicitResult requires content
whenever the action is accept. The result carries no discriminator of its own,
so the mode has to come from the request it answers.

`supportsElicitationUrl()` reports whether the client named the mode, reusing
the sub-capability reader the sampling checks already use.

* [Schema] Add CHANGELOG entry for the 2026-07-28 surface

* [Capability][Schema][Server] Carry the widened structuredContent end to end

Review follow-up on the SEP-2106 widening, which stopped at the type.

`ToolReference::extractStructuredContent()` returned `?array`, so a tool
declaring a scalar `outputSchema` had its result dropped and logged as
unsendable. It returns `mixed` now and keeps a scalar — but only from
2026-07-28 on, and only when the tool declared an outputSchema: without one
the value is already carried in `content`, and advertising it twice is not an
improvement.

`CallToolHandler` only warned about list-shaped `structuredContent` on a
self-built `CallToolResult`, so a scalar reached revisions that require an
object unremarked. The check is on the shape now, not on the list case alone.

`ElicitResult` retained a `content` the spec says is absent from url-mode
results, leaving a malformed response indistinguishable from a valid one.

`Tool::jsonSerialize()` emitted the empty root schema as `[]`, which is not a
schema at all. Sub-schemas already had this treatment.
2026-08-17 23:09:39 +02:00

208 lines
7.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;
use Mcp\Exception\InvalidArgumentException;
use Mcp\Schema\Implementation;
use PHPUnit\Framework\TestCase;
final class ImplementationTest extends TestCase
{
public function testConstructorDefaults(): void
{
$implementation = new Implementation();
$this->assertSame('app', $implementation->name);
$this->assertSame('dev', $implementation->version);
$this->assertNull($implementation->description);
$this->assertNull($implementation->icons);
$this->assertNull($implementation->websiteUrl);
$this->assertNull($implementation->title);
}
public function testFromArrayWithMinimalData(): void
{
$implementation = Implementation::fromArray([
'name' => 'my-client',
'version' => '1.2.3',
]);
$this->assertSame('my-client', $implementation->name);
$this->assertSame('1.2.3', $implementation->version);
$this->assertNull($implementation->description);
$this->assertNull($implementation->icons);
$this->assertNull($implementation->websiteUrl);
}
public function testFromArrayWithAllFields(): void
{
$implementation = Implementation::fromArray([
'name' => 'my-client',
'version' => '1.2.3',
'description' => 'A test client',
'icons' => [['src' => 'https://example.com/icon.png']],
'websiteUrl' => 'https://example.com',
]);
$this->assertSame('my-client', $implementation->name);
$this->assertSame('1.2.3', $implementation->version);
$this->assertSame('A test client', $implementation->description);
$this->assertIsArray($implementation->icons);
$this->assertCount(1, $implementation->icons);
$this->assertSame('https://example.com', $implementation->websiteUrl);
}
/**
* Regression test for #392: falsy-but-valid version strings such as "0"
* were rejected because empty('0') === true.
*/
public function testFromArrayAcceptsZeroStringVersion(): void
{
$implementation = Implementation::fromArray([
'name' => 'my-client',
'version' => '0',
]);
$this->assertSame('0', $implementation->version);
}
/**
* Regression test for #392: a name of "0" is a valid string and must be accepted.
*/
public function testFromArrayAcceptsZeroStringName(): void
{
$implementation = Implementation::fromArray([
'name' => '0',
'version' => '1.0.0',
]);
$this->assertSame('0', $implementation->name);
}
public function testFromArrayThrowsOnMissingName(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid or missing "name" in Implementation data.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['version' => '1.0.0']);
}
public function testFromArrayThrowsOnEmptyName(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid or missing "name" in Implementation data.');
Implementation::fromArray(['name' => '', 'version' => '1.0.0']);
}
public function testFromArrayThrowsOnNonStringName(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid or missing "name" in Implementation data.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['name' => 123, 'version' => '1.0.0']);
}
public function testFromArrayThrowsOnMissingVersion(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid or missing "version" in Implementation data.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['name' => 'my-client']);
}
public function testFromArrayThrowsOnEmptyVersion(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid or missing "version" in Implementation data.');
Implementation::fromArray(['name' => 'my-client', 'version' => '']);
}
public function testFromArrayThrowsOnNonStringVersion(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid or missing "version" in Implementation data.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['name' => 'my-client', 'version' => 1]);
}
public function testFromArrayThrowsOnNonArrayIcons(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid "icons" in Implementation data; expected an array.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['name' => 'my-client', 'version' => '1.0.0', 'icons' => 'nope']);
}
public function testFromArrayThrowsOnNonStringDescription(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid "description" in Implementation data.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['name' => 'my-client', 'version' => '1.0.0', 'description' => 42]);
}
public function testFromArrayThrowsOnNonStringTitle(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid "title" in Implementation data.');
/* @phpstan-ignore argument.type */
Implementation::fromArray(['name' => 'my-client', 'version' => '1.0.0', 'title' => ['nope']]);
}
public function testFromArrayReadsTitle(): void
{
$implementation = Implementation::fromArray([
'name' => 'my-client',
'version' => '1.0.0',
'title' => 'My Client',
]);
$this->assertSame('My Client', $implementation->title);
$this->assertArrayHasKey('title', $implementation->jsonSerialize());
}
public function testJsonSerializeRoundTrip(): void
{
$implementation = Implementation::fromArray([
'name' => 'my-client',
'version' => '0',
'description' => 'A test client',
'websiteUrl' => 'https://example.com',
]);
$this->assertSame([
'name' => 'my-client',
'version' => '0',
'description' => 'A test client',
'websiteUrl' => 'https://example.com',
], $implementation->jsonSerialize());
}
public function testJsonSerializeOmitsNullOptionalFields(): void
{
$implementation = new Implementation('my-client', '1.0.0');
$this->assertSame([
'name' => 'my-client',
'version' => '1.0.0',
], $implementation->jsonSerialize());
}
}