[Client] Speak the 2026-07-28 lifecycle (#456)
* [Client] Speak the 2026-07-28 lifecycle On that revision the client opens with server/discover instead of initialize, stamps each request's _meta with the protocol version, its own capabilities and client info, and sends the standard Mcp-Method / Mcp-Name / Mcp-Param-* headers an intermediary routes on. ToolCatalog is what knows, from the tool list, which arguments a call has to mirror. An input_required result is answered rather than surfaced: InputRequestResolver asks the host's elicitation, sampling and roots handlers and retries the same request carrying inputResponses and the requestState the server sent. McpHeader holds the header names and the =?base64?…?= sentinel, so the two sides no longer keep their own copies of the same rules. * Fix CI baseline drift and address Copilot review findings Drop stale expected-failure entries the new client fixture now passes. Copilot review: fix McpHeader round-trip for a wrapper-shaped literal, encode empty/numeric-keyed inputResponses as a JSON object, stop the incident example repeating side effects on MRTR retry, and reset ToolCatalog on reconnect instead of carrying the previous server's verdicts. * Skip DualEraExampleTestCase on PHP 8.1 PHP_CLI_SERVER_WORKERS does not reliably fork multiple php -S workers there (php/php-src#9400), reproducing the single-worker deadlock the extra workers exist to avoid.
This commit is contained in:
Christopher Hertel
GitHub
parent
cbceef06eb
commit
8c06dcecc6
1 changed files with 2443 additions and 248 deletions
|
|
@ -15,6 +15,7 @@ use Mcp\Client\Configuration;
|
|||
use Mcp\Client\Protocol;
|
||||
use Mcp\Client\State\ClientStateInterface;
|
||||
use Mcp\Client\Transport\TransportInterface;
|
||||
use Mcp\Exception\ConnectionException;
|
||||
use Mcp\Exception\LogicException;
|
||||
use Mcp\Schema\ClientCapabilities;
|
||||
use Mcp\Schema\Enum\ProtocolVersion;
|
||||
|
|
@ -22,6 +23,8 @@ use Mcp\Schema\Implementation;
|
|||
use Mcp\Schema\JsonRpc\Error;
|
||||
use Mcp\Schema\JsonRpc\MessageInterface;
|
||||
use Mcp\Schema\JsonRpc\Response;
|
||||
use Mcp\Schema\Request\PingRequest;
|
||||
use Mcp\Server\Stateless\RequestMeta;
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
|
@ -42,20 +45,64 @@ final class ProtocolTest extends TestCase
|
|||
$this->assertSame(ProtocolVersion::V2025_06_18->value, $transport->offeredVersion);
|
||||
}
|
||||
|
||||
#[TestDox('never offers a modern version over the initialize handshake, and warns about it')]
|
||||
public function testDoesNotOfferModernVersionOverHandshake(): void
|
||||
#[TestDox('never sends "initialize" on a modern revision, which removed it')]
|
||||
public function testModernRevisionSkipsTheHandshake(): void
|
||||
{
|
||||
$transport = new RecordingTransport(ProtocolVersion::latestHandshake()->value);
|
||||
$protocol = new Protocol(logger: $logger = new CollectingLogger());
|
||||
$transport = new RecordingTransport(ProtocolVersion::V2026_07_28->value);
|
||||
$protocol = new Protocol();
|
||||
$protocol->connect($transport, $config = $this->createConfiguration(ProtocolVersion::V2026_07_28));
|
||||
|
||||
$protocol->initialize($config);
|
||||
|
||||
$this->assertSame(ProtocolVersion::latestHandshake()->value, $transport->offeredVersion);
|
||||
$this->assertSame([[
|
||||
'configured' => ProtocolVersion::V2026_07_28->value,
|
||||
'offered' => ProtocolVersion::latestHandshake()->value,
|
||||
]], $logger->warnings);
|
||||
$this->assertNotContains('initialize', $transport->methods);
|
||||
$this->assertNotContains('notifications/initialized', $transport->methods);
|
||||
$this->assertSame(ProtocolVersion::V2026_07_28, $protocol->getState()->getProtocolVersion());
|
||||
$this->assertTrue($protocol->getState()->isInitialized());
|
||||
}
|
||||
|
||||
#[TestDox('carries the revision, capabilities and client info on every modern request')]
|
||||
public function testModernRequestsCarryTheEnvelope(): void
|
||||
{
|
||||
$transport = new RecordingTransport(ProtocolVersion::V2026_07_28->value);
|
||||
$protocol = new Protocol();
|
||||
$protocol->connect($transport, $config = $this->createConfiguration(ProtocolVersion::V2026_07_28));
|
||||
|
||||
$protocol->initialize($config);
|
||||
|
||||
$this->assertNotSame([], $transport->metas);
|
||||
|
||||
foreach ($transport->metas as $meta) {
|
||||
$this->assertSame(ProtocolVersion::V2026_07_28->value, $meta[RequestMeta::PROTOCOL_VERSION] ?? null);
|
||||
$this->assertArrayHasKey(RequestMeta::CLIENT_CAPABILITIES, $meta);
|
||||
$this->assertSame('client-app', $meta[RequestMeta::CLIENT_INFO]['name'] ?? null);
|
||||
}
|
||||
}
|
||||
|
||||
#[TestDox('a server that refuses "server/discover" still leaves a usable connection')]
|
||||
public function testDiscoveryFailureIsNotFatal(): void
|
||||
{
|
||||
$transport = new RecordingTransport(ProtocolVersion::V2026_07_28->value, refuseDiscovery: true);
|
||||
$protocol = new Protocol();
|
||||
$protocol->connect($transport, $config = $this->createConfiguration(ProtocolVersion::V2026_07_28));
|
||||
|
||||
$protocol->initialize($config);
|
||||
|
||||
$this->assertTrue($protocol->getState()->isInitialized());
|
||||
}
|
||||
|
||||
#[TestDox('refuses to continue when discovery shows the server has no modern revision')]
|
||||
public function testDiscoveryWithoutAModernRevisionFails(): void
|
||||
{
|
||||
// Advertising only handshake revisions leaves nothing this connection
|
||||
// can use: it has already skipped the handshake.
|
||||
$transport = new RecordingTransport(ProtocolVersion::V2025_11_25->value);
|
||||
$protocol = new Protocol();
|
||||
$protocol->connect($transport, $config = $this->createConfiguration(ProtocolVersion::V2026_07_28));
|
||||
|
||||
$this->expectException(ConnectionException::class);
|
||||
$this->expectExceptionMessage('does not support any modern protocol revision');
|
||||
|
||||
$protocol->initialize($config);
|
||||
}
|
||||
|
||||
#[TestDox('accepts a counter-offer the SDK can speak and records it as negotiated')]
|
||||
|
|
@ -126,6 +173,41 @@ final class ProtocolTest extends TestCase
|
|||
$this->assertSame(Error::METHOD_NOT_FOUND, $response->code);
|
||||
}
|
||||
|
||||
#[TestDox('reconnecting starts with a fresh tool catalog, not the previous server\'s verdicts')]
|
||||
public function testReconnectResetsToolCatalog(): void
|
||||
{
|
||||
$protocol = new Protocol();
|
||||
$protocol->connect(new RecordingTransport(ProtocolVersion::V2025_11_25->value), $config = $this->createConfiguration(ProtocolVersion::V2025_11_25));
|
||||
|
||||
$protocol->getToolCatalog()->record([[
|
||||
'name' => 'broken',
|
||||
'inputSchema' => [
|
||||
'type' => 'object',
|
||||
'properties' => ['data' => ['type' => 'object', 'x-mcp-header' => 'Data']],
|
||||
],
|
||||
]]);
|
||||
|
||||
$this->assertTrue($protocol->getToolCatalog()->isRejected('broken'));
|
||||
|
||||
$protocol->connect(new RecordingTransport(ProtocolVersion::V2025_11_25->value), $config);
|
||||
|
||||
$this->assertFalse($protocol->getToolCatalog()->isRejected('broken'), 'the previous server\'s verdict must not survive a reconnect');
|
||||
}
|
||||
|
||||
#[TestDox('an empty inputResponses map is retried as a JSON object, never an array')]
|
||||
public function testEmptyInputResponsesEncodesAsJsonObject(): void
|
||||
{
|
||||
$transport = new InputRequiredRoundTripTransport();
|
||||
$protocol = new Protocol();
|
||||
$protocol->connect($transport, $this->createConfiguration(ProtocolVersion::V2026_07_28));
|
||||
|
||||
$result = $protocol->request(new PingRequest(), 5);
|
||||
|
||||
$this->assertInstanceOf(Response::class, $result);
|
||||
$this->assertStringContainsString('"inputResponses":{}', $transport->retryBody);
|
||||
$this->assertStringNotContainsString('"inputResponses":[]', $transport->retryBody);
|
||||
}
|
||||
|
||||
private function createConfiguration(ProtocolVersion $protocolVersion): Configuration
|
||||
{
|
||||
return new Configuration(
|
||||
|
|
@ -137,38 +219,164 @@ final class ProtocolTest extends TestCase
|
|||
}
|
||||
|
||||
/**
|
||||
* Transport that answers the `initialize` request inline with a canned
|
||||
* `protocolVersion`, so the handshake resolves without a Fiber round-trip.
|
||||
* Answers the first request with an empty `input_required` ask and the retry
|
||||
* with success, capturing the retry's raw body so the test can inspect how
|
||||
* `inputResponses` was actually encoded on the wire.
|
||||
*/
|
||||
final class InputRequiredRoundTripTransport implements TransportInterface
|
||||
{
|
||||
public string $retryBody = '';
|
||||
|
||||
private int $calls = 0;
|
||||
private ClientStateInterface $state;
|
||||
|
||||
public function setState(ClientStateInterface $state): void
|
||||
{
|
||||
$this->state = $state;
|
||||
}
|
||||
|
||||
public function send(string $data): void
|
||||
{
|
||||
/** @var array{id: int} $message */
|
||||
$message = json_decode($data, true);
|
||||
$id = $message['id'];
|
||||
|
||||
if (0 === $this->calls++) {
|
||||
$this->answer($id, ['resultType' => 'input_required', 'inputRequests' => []]);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->retryBody = $data;
|
||||
|
||||
$this->answer($id, ['resultType' => 'complete']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $result
|
||||
*/
|
||||
private function answer(int $id, array $result): void
|
||||
{
|
||||
$this->state->storeResponse($id, [
|
||||
'jsonrpc' => MessageInterface::JSONRPC_VERSION,
|
||||
'id' => $id,
|
||||
'result' => $result,
|
||||
]);
|
||||
}
|
||||
|
||||
public function connect(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function close(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function runRequest(\Fiber $fiber, ?callable $onProgress = null): Response|Error
|
||||
{
|
||||
throw new LogicException('Not used in this test.');
|
||||
}
|
||||
|
||||
public function onInitialize(callable $callback): void
|
||||
{
|
||||
}
|
||||
|
||||
public function onMessage(callable $callback): void
|
||||
{
|
||||
}
|
||||
|
||||
public function onError(callable $callback): void
|
||||
{
|
||||
}
|
||||
|
||||
public function onClose(callable $callback): void
|
||||
{
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Transport that answers inline, so a request resolves without a Fiber
|
||||
* round-trip: `initialize` with a canned `protocolVersion`, and
|
||||
* `server/discover` with a minimal modern-era answer.
|
||||
*/
|
||||
final class RecordingTransport implements TransportInterface
|
||||
{
|
||||
public ?string $offeredVersion = null;
|
||||
|
||||
/** @var list<string> every method that reached the wire, in order */
|
||||
public array $methods = [];
|
||||
|
||||
/** @var list<array<string, mixed>> the `_meta` each request carried */
|
||||
public array $metas = [];
|
||||
|
||||
private ClientStateInterface $state;
|
||||
|
||||
public function __construct(private readonly string $counterOffer)
|
||||
{
|
||||
public function __construct(
|
||||
private readonly string $counterOffer,
|
||||
private readonly bool $refuseDiscovery = false,
|
||||
) {
|
||||
}
|
||||
|
||||
public function send(string $data): void
|
||||
{
|
||||
/** @var array{id: int|string, method: string, params?: array{protocolVersion?: string}} $message */
|
||||
/** @var array{id?: int|string, method?: string, params?: array<string, mixed>} $message */
|
||||
$message = json_decode($data, true);
|
||||
$method = $message['method'] ?? null;
|
||||
|
||||
if ('initialize' !== ($message['method'] ?? null)) {
|
||||
if (!\is_string($method)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->offeredVersion = $message['params']['protocolVersion'] ?? null;
|
||||
$this->methods[] = $method;
|
||||
$this->metas[] = $message['params']['_meta'] ?? [];
|
||||
|
||||
$this->state->storeResponse($message['id'], [
|
||||
'jsonrpc' => MessageInterface::JSONRPC_VERSION,
|
||||
'id' => $message['id'],
|
||||
'result' => [
|
||||
if (!isset($message['id'])) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ('initialize' === $method) {
|
||||
$this->offeredVersion = $message['params']['protocolVersion'] ?? null;
|
||||
|
||||
$this->answer($message['id'], [
|
||||
'protocolVersion' => $this->counterOffer,
|
||||
'capabilities' => [],
|
||||
'serverInfo' => ['name' => 'server', 'version' => '1.2.3'],
|
||||
],
|
||||
]);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ('server/discover' !== $method) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->refuseDiscovery) {
|
||||
$this->state->storeResponse($message['id'], [
|
||||
'jsonrpc' => MessageInterface::JSONRPC_VERSION,
|
||||
'id' => $message['id'],
|
||||
'error' => ['code' => -32601, 'message' => 'Method not found'],
|
||||
]);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->answer($message['id'], [
|
||||
'resultType' => 'complete',
|
||||
'supportedVersions' => [$this->counterOffer],
|
||||
'capabilities' => [],
|
||||
'serverInfo' => ['name' => 'server', 'version' => '1.2.3'],
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $result
|
||||
*/
|
||||
private function answer(int|string $id, array $result): void
|
||||
{
|
||||
$this->state->storeResponse($id, [
|
||||
'jsonrpc' => MessageInterface::JSONRPC_VERSION,
|
||||
'id' => $id,
|
||||
'result' => $result,
|
||||
]);
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue