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.
109 lines
3.3 KiB
PHP
109 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\Server;
|
|
|
|
use Mcp\Exception\ClientException;
|
|
use Mcp\Schema\JsonRpc\Error;
|
|
use Mcp\Schema\JsonRpc\Response;
|
|
use Mcp\Schema\Request\ListRootsRequest;
|
|
use Mcp\Schema\Result\ListRootsResult;
|
|
use Mcp\Server\ClientGateway;
|
|
use Mcp\Server\Session\SessionInterface;
|
|
use PHPUnit\Framework\TestCase;
|
|
use Symfony\Component\Uid\Uuid;
|
|
|
|
final class ClientGatewayTest extends TestCase
|
|
{
|
|
public function testSupportsRootsReturnsTrueWhenAdvertised(): void
|
|
{
|
|
$session = $this->createMock(SessionInterface::class);
|
|
$session->method('get')->with('client_capabilities', [])->willReturn(['roots' => []]);
|
|
|
|
$gateway = new ClientGateway($session);
|
|
|
|
$this->assertTrue($gateway->supportsRoots());
|
|
}
|
|
|
|
public function testSupportsRootsReturnsFalseWhenNotAdvertised(): void
|
|
{
|
|
$session = $this->createMock(SessionInterface::class);
|
|
$session->method('get')->with('client_capabilities', [])->willReturn(['sampling' => []]);
|
|
|
|
$gateway = new ClientGateway($session);
|
|
|
|
$this->assertFalse($gateway->supportsRoots());
|
|
}
|
|
|
|
public function testListRootsReturnsRootsFromClient(): void
|
|
{
|
|
$session = $this->createMock(SessionInterface::class);
|
|
$session->method('getId')->willReturn(Uuid::v4());
|
|
|
|
$gateway = new ClientGateway($session);
|
|
|
|
$response = $this->response([
|
|
'roots' => [
|
|
['uri' => 'file:///home/user/project', 'name' => 'project'],
|
|
],
|
|
]);
|
|
|
|
$result = $this->runInFiber(static fn (): ListRootsResult => $gateway->listRoots(), $response);
|
|
|
|
$this->assertInstanceOf(ListRootsResult::class, $result);
|
|
$this->assertCount(1, $result->roots);
|
|
$this->assertSame('file:///home/user/project', $result->roots[0]->uri);
|
|
}
|
|
|
|
public function testListRootsThrowsClientExceptionOnError(): void
|
|
{
|
|
$session = $this->createMock(SessionInterface::class);
|
|
$session->method('getId')->willReturn(Uuid::v4());
|
|
|
|
$gateway = new ClientGateway($session);
|
|
|
|
$error = Error::forInternalError('nope', '1');
|
|
|
|
$this->expectException(ClientException::class);
|
|
|
|
$this->runInFiber(static fn (): ListRootsResult => $gateway->listRoots(), $error);
|
|
}
|
|
|
|
/**
|
|
* Runs the gateway call inside a Fiber, asserts it suspends with a roots/list
|
|
* request, then resumes it with the given client response.
|
|
*
|
|
* @param Response<array<string, mixed>>|Error $response
|
|
*/
|
|
private function runInFiber(\Closure $call, Response|Error $response): mixed
|
|
{
|
|
$fiber = new \Fiber($call);
|
|
$suspend = $fiber->start();
|
|
|
|
$this->assertIsArray($suspend);
|
|
$this->assertSame('request', $suspend['type']);
|
|
$this->assertInstanceOf(ListRootsRequest::class, $suspend['request']);
|
|
|
|
$fiber->resume($response);
|
|
|
|
return $fiber->getReturn();
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $result
|
|
*
|
|
* @return Response<array<string, mixed>>
|
|
*/
|
|
private function response(array $result): Response
|
|
{
|
|
return new Response('1', $result);
|
|
}
|
|
}
|