bdc9d86671* [Client][Server] Add Roots support Wire up the MCP "roots" capability on both sides: Client (php-sdk as client): - RootsCallbackInterface + ListRootsRequestHandler answer server roots/list requests, mirroring the Sampling handler. - Client::sendRootsListChanged() emits notifications/roots/list_changed. Server (php-sdk as server): - ClientGateway::listRoots() requests the client's roots, and supportsRoots() reports whether the client advertised the capability, normalizing the stored capabilities to an array so an empty capabilities object (\stdClass) doesn't cause a TypeError. - Add ListRootsResult::fromArray() (used by listRoots()). - ListRootsRequestHandler forwards RootsException messages to the server (new Mcp\Exception\RootsException), mirroring SamplingRequestHandler. - Client::sendRootsListChanged() throws when the client did not advertise the roots.listChanged capability. Examples, docs and tests: - examples/README/docs advertise `new ClientCapabilities(roots: true, rootsListChanged: true)` before sending notifications/roots/list_changed. - CHANGELOG entry for Roots (unreleased 0.7.0 section at the time). - Unit tests for capability serialization/round-trip, sendRootsListChanged gating, and RootsException message forwarding. phpunit, php-cs-fixer and phpstan green. * [Client][Server] Address review: schema validation, changelog section, connection guard, working example Responds to chr-hertel's review of the Roots support: - ListRootsResult::fromArray() rejects non-array root elements instead of accepting malformed entries silently. - CHANGELOG entry moved to the next unreleased section as the release train advanced past it (0.7.0 -> 0.8.0). - Client::sendRootsListChanged() went straight to Protocol::sendNotification(), which sends via `$this->transport?->send()` -- on a client that is not connected the notification was silently dropped. It now throws a ConnectionException like sendRequest() does. - The stdio example only advertised the roots capability, so the roots/list handler never actually ran. The client-communication demo server gets an `inspect_workspace_roots` tool that calls ClientGateway::supportsRoots()/listRoots(); the example calls it, so the server actually issues roots/list and the client answers it. Dropped the try/catch wrapper from the example. - ClientTest's connected-client mock now goes through setState() so isConnected() reflects a real handshake instead of a stubbed flag. phpunit, php-cs-fixer and phpstan green.
110 lines
3.3 KiB
PHP
110 lines
3.3 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\Result\ListRootsResult;
|
|
use Mcp\Schema\Root;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
final class ListRootsResultTest extends TestCase
|
|
{
|
|
public function testConstructor(): void
|
|
{
|
|
$roots = [new Root('file:///home/user/project', 'project')];
|
|
$result = new ListRootsResult($roots);
|
|
|
|
$this->assertSame($roots, $result->roots);
|
|
$this->assertNull($result->meta);
|
|
}
|
|
|
|
public function testFromArray(): void
|
|
{
|
|
$result = ListRootsResult::fromArray([
|
|
'roots' => [
|
|
['uri' => 'file:///home/user/project', 'name' => 'project'],
|
|
['uri' => 'file:///tmp'],
|
|
],
|
|
]);
|
|
|
|
$this->assertCount(2, $result->roots);
|
|
$this->assertSame('file:///home/user/project', $result->roots[0]->uri);
|
|
$this->assertSame('project', $result->roots[0]->name);
|
|
$this->assertSame('file:///tmp', $result->roots[1]->uri);
|
|
$this->assertNull($result->roots[1]->name);
|
|
$this->assertNull($result->meta);
|
|
}
|
|
|
|
public function testFromArrayWithMeta(): void
|
|
{
|
|
$result = ListRootsResult::fromArray([
|
|
'roots' => [['uri' => 'file:///tmp']],
|
|
'_meta' => ['requestId' => 'abc'],
|
|
]);
|
|
|
|
$this->assertSame(['requestId' => 'abc'], $result->meta);
|
|
}
|
|
|
|
public function testFromArrayWithMissingRoots(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
$this->expectExceptionMessage('Missing or invalid "roots"');
|
|
|
|
/* @phpstan-ignore argument.type */
|
|
ListRootsResult::fromArray([]);
|
|
}
|
|
|
|
public function testFromArrayWithNonArrayRoot(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
$this->expectExceptionMessage('Invalid root in ListRootsResult data, expected an array.');
|
|
|
|
/* @phpstan-ignore argument.type */
|
|
ListRootsResult::fromArray([
|
|
'roots' => ['file:///tmp'],
|
|
]);
|
|
}
|
|
|
|
public function testFromArrayRejectsNonFileUri(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
$this->expectExceptionMessage('must start with "file://"');
|
|
|
|
ListRootsResult::fromArray([
|
|
'roots' => [['uri' => 'https://example.com']],
|
|
]);
|
|
}
|
|
|
|
public function testFromArrayRoundTrip(): void
|
|
{
|
|
$data = [
|
|
'roots' => [
|
|
['uri' => 'file:///home/user/project', 'name' => 'project'],
|
|
['uri' => 'file:///tmp'],
|
|
],
|
|
'_meta' => ['foo' => 'bar'],
|
|
];
|
|
|
|
$result = ListRootsResult::fromArray($data);
|
|
|
|
$this->assertSame($data, json_decode(json_encode($result), true));
|
|
}
|
|
|
|
public function testJsonSerializeWithoutMeta(): void
|
|
{
|
|
$result = new ListRootsResult([new Root('file:///tmp')]);
|
|
|
|
$this->assertSame([
|
|
'roots' => [['uri' => 'file:///tmp']],
|
|
], json_decode(json_encode($result), true));
|
|
}
|
|
}
|