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.
105 lines
3.5 KiB
PHP
105 lines
3.5 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\Client\Handler\Request;
|
|
|
|
use Mcp\Client\Handler\Request\ListRootsRequestHandler;
|
|
use Mcp\Client\Handler\Request\RootsCallbackInterface;
|
|
use Mcp\Exception\RootsException;
|
|
use Mcp\Schema\JsonRpc\Error;
|
|
use Mcp\Schema\JsonRpc\Response;
|
|
use Mcp\Schema\Request\ListRootsRequest;
|
|
use Mcp\Schema\Request\PingRequest;
|
|
use Mcp\Schema\Result\ListRootsResult;
|
|
use Mcp\Schema\Root;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
final class ListRootsRequestHandlerTest extends TestCase
|
|
{
|
|
public function testSupportsListRootsRequest(): void
|
|
{
|
|
$handler = new ListRootsRequestHandler($this->createCallback(new ListRootsResult([])));
|
|
|
|
$this->assertTrue($handler->supports(new ListRootsRequest()));
|
|
}
|
|
|
|
public function testDoesNotSupportOtherRequests(): void
|
|
{
|
|
$handler = new ListRootsRequestHandler($this->createCallback(new ListRootsResult([])));
|
|
|
|
$this->assertFalse($handler->supports(new PingRequest()));
|
|
}
|
|
|
|
public function testHandleReturnsRootsFromCallback(): void
|
|
{
|
|
$result = new ListRootsResult([
|
|
new Root('file:///home/user/project', 'project'),
|
|
new Root('file:///tmp'),
|
|
]);
|
|
|
|
$handler = new ListRootsRequestHandler($this->createCallback($result));
|
|
|
|
$request = (new ListRootsRequest())->withId('req-1');
|
|
$response = $handler->handle($request);
|
|
|
|
$this->assertInstanceOf(Response::class, $response);
|
|
$this->assertSame('req-1', $response->getId());
|
|
$this->assertSame($result, $response->result);
|
|
}
|
|
|
|
public function testHandleReturnsErrorWhenCallbackThrows(): void
|
|
{
|
|
$handler = new ListRootsRequestHandler(new class implements RootsCallbackInterface {
|
|
public function __invoke(ListRootsRequest $request): ListRootsResult
|
|
{
|
|
throw new \RuntimeException('boom');
|
|
}
|
|
});
|
|
|
|
$request = (new ListRootsRequest())->withId('req-2');
|
|
$response = $handler->handle($request);
|
|
|
|
$this->assertInstanceOf(Error::class, $response);
|
|
$this->assertSame('req-2', $response->getId());
|
|
$this->assertSame('Error while listing roots', $response->message);
|
|
}
|
|
|
|
public function testHandleForwardsRootsExceptionMessage(): void
|
|
{
|
|
$handler = new ListRootsRequestHandler(new class implements RootsCallbackInterface {
|
|
public function __invoke(ListRootsRequest $request): ListRootsResult
|
|
{
|
|
throw new RootsException('permission denied');
|
|
}
|
|
});
|
|
|
|
$request = (new ListRootsRequest())->withId('req-3');
|
|
$response = $handler->handle($request);
|
|
|
|
$this->assertInstanceOf(Error::class, $response);
|
|
$this->assertSame('req-3', $response->getId());
|
|
$this->assertSame('permission denied', $response->message);
|
|
}
|
|
|
|
private function createCallback(ListRootsResult $result): RootsCallbackInterface
|
|
{
|
|
return new class($result) implements RootsCallbackInterface {
|
|
public function __construct(private readonly ListRootsResult $result)
|
|
{
|
|
}
|
|
|
|
public function __invoke(ListRootsRequest $request): ListRootsResult
|
|
{
|
|
return $this->result;
|
|
}
|
|
};
|
|
}
|
|
}
|