modelcontextprotocol/php-sdk
Watch
1
0
Fork
You've already forked php-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add RequestContext and logging (#176)

Browse source 
* Implemented MCP logging specification with auto-injection

* Add RequestContext

* fix tests and style

* Better deprecation

* fix: minor

* Remove ClientAwareInterface

* fix cs

* fix docs

---------

Co-authored-by: Adam Jamiu <jamiuadam120@gmail.com>
This commit is contained in:
Tobias Nyholm 2025-12-16 00:12:02 +01:00 • committed by GitHub
commit a1e0f61b6b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 578 additions and 162 deletions
Download patch file Download diff file Expand all files Collapse all files

92
tests/Unit/Capability/Logger/ClientLoggerTest.php Normal file
View file

@ -0,0 +1,92 @@
<?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\Capability\Logger;
use Mcp\Capability\Logger\ClientLogger;
use Mcp\Schema\Enum\LoggingLevel;
use Mcp\Server\ClientGateway;
use Mcp\Server\Session\Session;
use PHPUnit\Framework\TestCase;
/**
* Test for simplified ClientLogger PSR-3 compliance.
*/
final class ClientLoggerTest extends TestCase
{
public function testLog()
{
$session = $this->getMockBuilder(Session::class)
->disableOriginalConstructor()
->onlyMethods(['get'])
->getMock();
$session->expects($this->once())->method('get')->willReturn('info');
$clientGateway = $this->getMockBuilder(ClientGateway::class)
->disableOriginalConstructor()
->onlyMethods(['log'])
->getMock();
$clientGateway->expects($this->once())->method('log')->with(LoggingLevel::Notice, 'test');
$logger = new ClientLogger($clientGateway, $session);
$logger->notice('test');
}
public function testLogFilter()
{
$session = $this->getMockBuilder(Session::class)
->disableOriginalConstructor()
->onlyMethods(['get'])
->getMock();
$session->expects($this->once())->method('get')->willReturn('info');
$clientGateway = $this->getMockBuilder(ClientGateway::class)
->disableOriginalConstructor()
->onlyMethods(['log'])
->getMock();
$clientGateway->expects($this->never())->method('log');
$logger = new ClientLogger($clientGateway, $session);
$logger->debug('test');
}
public function testLogFilterSameLevel()
{
$session = $this->getMockBuilder(Session::class)
->disableOriginalConstructor()
->onlyMethods(['get'])
->getMock();
$session->expects($this->once())->method('get')->willReturn('info');
$clientGateway = $this->getMockBuilder(ClientGateway::class)
->disableOriginalConstructor()
->onlyMethods(['log'])
->getMock();
$clientGateway->expects($this->once())->method('log');
$logger = new ClientLogger($clientGateway, $session);
$logger->info('test');
}
public function testLogWithInvalidLevel()
{
$session = $this->getMockBuilder(Session::class)
->disableOriginalConstructor()
->onlyMethods(['get'])
->getMock();
$session->expects($this->any())->method('get')->willReturn('info');
$clientGateway = $this->getMockBuilder(ClientGateway::class)
->disableOriginalConstructor()
->onlyMethods(['log'])
->getMock();
$clientGateway->expects($this->never())->method('log');
$logger = new ClientLogger($clientGateway, $session);
$logger->log('foo', 'test');
}
}

24
tests/Unit/Server/Handler/Request/CallToolHandlerTest.php
View file

@ -71,7 +71,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['name' => 'John', '_session' => $this->session])
->with($toolReference, ['name' => 'John', '_session' => $this->session, '_request' => $request])
->willReturn('Hello, John!');
$toolReference
@ -104,7 +104,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['_session' => $this->session])
->with($toolReference, ['_session' => $this->session, '_request' => $request])
->willReturn('Simple result');
$toolReference
@ -141,7 +141,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, array_merge($arguments, ['_session' => $this->session]))
->with($toolReference, array_merge($arguments, ['_session' => $this->session, '_request' => $request]))
->willReturn('Complex result');
$toolReference
@ -192,7 +192,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['param' => 'value', '_session' => $this->session])
->with($toolReference, ['param' => 'value', '_session' => $this->session, '_request' => $request])
->willThrowException($exception);
$this->logger
@ -227,7 +227,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['_session' => $this->session])
->with($toolReference, ['_session' => $this->session, '_request' => $request])
->willReturn(null);
$toolReference
@ -264,7 +264,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['key1' => 'value1', 'key2' => 42, '_session' => $this->session])
->with($toolReference, ['key1' => 'value1', 'key2' => 42, '_session' => $this->session, '_request' => $request])
->willThrowException($exception);
$this->logger
@ -274,7 +274,7 @@ class CallToolHandlerTest extends TestCase
'Error while executing tool "test_tool": "Custom error message".',
[
'tool' => 'test_tool',
'arguments' => ['key1' => 'value1', 'key2' => 42, '_session' => $this->session],
'arguments' => ['key1' => 'value1', 'key2' => 42, '_session' => $this->session, '_request' => $request],
],
);
@ -307,7 +307,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['param' => 'value', '_session' => $this->session])
->with($toolReference, ['param' => 'value', '_session' => $this->session, '_request' => $request])
->willThrowException($exception);
$response = $this->handler->handle($request, $this->session);
@ -334,7 +334,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['_session' => $this->session])
->with($toolReference, ['_session' => $this->session, '_request' => $request])
->willReturn('Special tool result');
$toolReference
@ -369,7 +369,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, array_merge($arguments, ['_session' => $this->session]))
->with($toolReference, array_merge($arguments, ['_session' => $this->session, '_request' => $request]))
->willReturn('Unicode handled');
$toolReference
@ -399,7 +399,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['query' => 'php', '_session' => $this->session])
->with($toolReference, ['query' => 'php', '_session' => $this->session, '_request' => $request])
->willReturn($structuredResult);
$toolReference
@ -428,7 +428,7 @@ class CallToolHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($toolReference, ['query' => 'php', '_session' => $this->session])
->with($toolReference, ['query' => 'php', '_session' => $this->session, '_request' => $request])
->willReturn($callToolResult);
$toolReference

18
tests/Unit/Server/Handler/Request/GetPromptHandlerTest.php
View file

@ -70,7 +70,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, ['_session' => $this->session])
->with($promptReference, ['_session' => $this->session, '_request' => $request])
->willReturn($expectedMessages);
$promptReference
@ -112,7 +112,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, array_merge($arguments, ['_session' => $this->session]))
->with($promptReference, array_merge($arguments, ['_session' => $this->session, '_request' => $request]))
->willReturn($expectedMessages);
$promptReference
@ -145,7 +145,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, ['_session' => $this->session])
->with($promptReference, ['_session' => $this->session, '_request' => $request])
->willReturn($expectedMessages);
$promptReference
@ -178,7 +178,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, ['_session' => $this->session])
->with($promptReference, ['_session' => $this->session, '_request' => $request])
->willReturn($expectedMessages);
$promptReference
@ -213,7 +213,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, ['_session' => $this->session])
->with($promptReference, ['_session' => $this->session, '_request' => $request])
->willReturn($expectedMessages);
$promptReference
@ -299,7 +299,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, array_merge($arguments, ['_session' => $this->session]))
->with($promptReference, array_merge($arguments, ['_session' => $this->session, '_request' => $request]))
->willReturn($expectedMessages);
$promptReference
@ -337,7 +337,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, array_merge($arguments, ['_session' => $this->session]))
->with($promptReference, array_merge($arguments, ['_session' => $this->session, '_request' => $request]))
->willReturn($expectedMessages);
$promptReference
@ -367,7 +367,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, ['_session' => $this->session])
->with($promptReference, ['_session' => $this->session, '_request' => $request])
->willReturn([]);
$promptReference
@ -405,7 +405,7 @@ class GetPromptHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($promptReference, array_merge($arguments, ['_session' => $this->session]))
->with($promptReference, array_merge($arguments, ['_session' => $this->session, '_request' => $request]))
->willReturn($expectedMessages);
$promptReference

12
tests/Unit/Server/Handler/Request/ReadResourceHandlerTest.php
View file

@ -75,7 +75,7 @@ class ReadResourceHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($resourceReference, ['uri' => $uri, '_session' => $this->session])
->with($resourceReference, ['uri' => $uri, '_session' => $this->session, '_request' => $request])
->willReturn('test');
$resourceReference
@ -115,7 +115,7 @@ class ReadResourceHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($resourceReference, ['uri' => $uri, '_session' => $this->session])
->with($resourceReference, ['uri' => $uri, '_session' => $this->session, '_request' => $request])
->willReturn('fake-image-data');
$resourceReference
@ -159,7 +159,7 @@ class ReadResourceHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($resourceReference, ['uri' => $uri, '_session' => $this->session])
->with($resourceReference, ['uri' => $uri, '_session' => $this->session, '_request' => $request])
->willReturn('binary-data');
$resourceReference
@ -267,7 +267,7 @@ class ReadResourceHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($resourceReference, ['uri' => $uri, '_session' => $this->session])
->with($resourceReference, ['uri' => $uri, '_session' => $this->session, '_request' => $request])
->willReturn('test');
$resourceReference
@ -312,7 +312,7 @@ class ReadResourceHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($resourceReference, ['uri' => $uri, '_session' => $this->session])
->with($resourceReference, ['uri' => $uri, '_session' => $this->session, '_request' => $request])
->willReturn('');
$resourceReference
@ -374,7 +374,7 @@ class ReadResourceHandlerTest extends TestCase
$this->referenceHandler
->expects($this->once())
->method('handle')
->with($resourceReference, ['uri' => $uri, '_session' => $this->session])
->with($resourceReference, ['uri' => $uri, '_session' => $this->session, '_request' => $request])
->willReturn($expectedContent);
$resourceReference

74
tests/Unit/Server/Handler/Request/SetLogLevelHandlerTest.php Normal file
View file

@ -0,0 +1,74 @@
<?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\Handler\Request;
use Mcp\Schema\Enum\LoggingLevel;
use Mcp\Schema\JsonRpc\Request;
use Mcp\Schema\Request\SetLogLevelRequest;
use Mcp\Schema\Result\EmptyResult;
use Mcp\Server\Handler\Request\SetLogLevelHandler;
use Mcp\Server\Protocol;
use Mcp\Server\Session\Session;
use PHPUnit\Framework\TestCase;
/**
* @author Adam Jamiu <jamiuadam120@gmail.com>
*/
class SetLogLevelHandlerTest extends TestCase
{
public function testSupports(): void
{
$request = $this->createSetLogLevelRequest(LoggingLevel::Info);
$handler = new SetLogLevelHandler();
$this->assertTrue($handler->supports($request));
}
public function testDoesNotSupportOtherRequests(): void
{
$otherRequest = $this->createMock(Request::class);
$handler = new SetLogLevelHandler();
$this->assertFalse($handler->supports($otherRequest));
}
public function testHandleAllLogLevelsAndSupport(): void
{
$handler = new SetLogLevelHandler();
foreach (LoggingLevel::cases() as $level) {
$request = $this->createSetLogLevelRequest($level);
$session = $this->getMockBuilder(Session::class)
->disableOriginalConstructor()
->onlyMethods(['set'])
->getMock();
$session->expects($this->once())
->method('set')
->with(Protocol::SESSION_LOGGING_LEVEL, $level->value);
$response = $handler->handle($request, $session);
$this->assertEquals($request->getId(), $response->id);
$this->assertInstanceOf(EmptyResult::class, $response->result);
}
}
private function createSetLogLevelRequest(LoggingLevel $level): SetLogLevelRequest
{
return SetLogLevelRequest::fromArray([
'jsonrpc' => '2.0',
'method' => SetLogLevelRequest::getMethod(),
'id' => 'test-request-'.uniqid(),
'params' => [
'level' => $level->value,
],
]);
}
}