* feat(schema): add top-level title to Tool Mirror PR #278's Prompt change for Tool: - Add optional ?string $title to Mcp\Schema\Tool between $name and $inputSchema. fromArray() now reads $data['title']; jsonSerialize() emits 'title' right after 'name'. The @phpstan-type ToolData gains title?: string. - Add ?string $title to the #[McpTool] attribute between $name and $description. - Note ToolAnnotations::$title as deprecated-for-display in favor of Tool::$title per MCP spec 2025-06-18 (PHPDoc only, field retained for BC). Phase 1 of plan 01--tool-title-spec-compliance. Later phases update Discoverer, Builder::addTool(), ArrayLoader, and the conformance fixture to match the new signature. * feat(server): thread title through discovery - Discoverer::processMethod() now propagates McpTool::$title into every discovered Tool via named arguments. - Builder::addTool() accepts ?string $title between $name and $description. [BC Break] positional callers passing the old $description as 3rd positional argument must switch to named arguments, matching the precedent set for addPrompt() in 0.5.0. - tests/Conformance/server.php migrated to named-argument form for every addTool() call. Phase 2 of plan 01--tool-title-spec-compliance. * feat(loader): forward title in ArrayLoader ArrayLoader now reads 'title' from each tool config entry and passes it into the Tool constructor, completing the wiring from Builder::addTool() through array-driven registration. The $tools @param array-shape typedef gains title: ?string between name and description. Phase 3 of plan 01--tool-title-spec-compliance. * test(schema): cover Tool.title end-to-end - New tests/Unit/Schema/ToolTest.php: constructor round-trip, jsonSerialize key-order when title set vs null, fromArray tolerance. - New tests/Unit/Capability/Discovery/DiscovererToolTitleTest plus a TitleFixture class verifying McpTool(title: ...) propagates through discovery into the registered Tool. - New tests/Unit/Capability/Registry/Loader/ArrayLoader... test verifying array-driven title propagation. - Extend McpToolTest for title named-arg and default-null. - Extend BuilderTest with addTool(title: 't') propagation. - Update tests/Unit/.../RegistryTest, CallToolHandlerTest, ListToolsHandlerTest and examples/.../server.php new Tool(...) call sites to pass title (named args) so they match the new constructor signature. - CHANGELOG 0.6.0 section: feature bullet + [BC Break] note for addTool() signature, mirroring 0.5.0 Prompt entries. - docs/server-builder.md: addTool() row and prose now list title? between name and description. Phase 4 of plan 01--tool-title-spec-compliance. All 730 phpunit tests pass; remaining phpstan warnings are pre-existing and unrelated to Tool.title. * refactor(schema): make Tool.title non-BC-breaking Move `title` to the end of the Tool, Builder::addTool, and McpTool attribute constructors with a default of null. This preserves positional-argument compatibility and removes the need for `title: null` boilerplate at call sites. JSON serialization order (name, title, inputSchema, ...) is unchanged. Also tighten the new tests: parameterize ToolTest with data providers, fold the Discoverer title fixture into the existing DiscoverableToolHandler, and drop the reflection-heavy Builder test that overlapped with ArrayLoaderToolTitleTest. * fix: move title after name --------- Co-authored-by: DDEV User <nobody@example.com>
111 lines
3.9 KiB
PHP
111 lines
3.9 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\Capability\Registry\ElementReference;
|
|
use Mcp\Capability\Registry\ReferenceHandlerInterface;
|
|
use Mcp\Schema\Content\TextContent;
|
|
use Mcp\Schema\JsonRpc\Response;
|
|
use Mcp\Schema\Request\CallToolRequest;
|
|
use Mcp\Server;
|
|
use Mcp\Server\Handler\Request\CallToolHandler;
|
|
use Mcp\Server\Session\SessionInterface;
|
|
use PHPUnit\Framework\Attributes\TestDox;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
final class BuilderTest extends TestCase
|
|
{
|
|
#[TestDox('setReferenceHandler() returns the builder for fluent chaining')]
|
|
public function testSetReferenceHandlerReturnsSelf(): void
|
|
{
|
|
$referenceHandler = $this->createStub(ReferenceHandlerInterface::class);
|
|
|
|
$builder = Server::builder();
|
|
$result = $builder->setReferenceHandler($referenceHandler);
|
|
|
|
$this->assertSame($builder, $result);
|
|
}
|
|
|
|
#[TestDox('build() succeeds with a custom ReferenceHandler')]
|
|
public function testBuildWithCustomReferenceHandler(): void
|
|
{
|
|
$referenceHandler = $this->createStub(ReferenceHandlerInterface::class);
|
|
|
|
$server = Server::builder()
|
|
->setServerInfo('test', '1.0.0')
|
|
->setReferenceHandler($referenceHandler)
|
|
->build();
|
|
|
|
$this->assertInstanceOf(Server::class, $server);
|
|
}
|
|
|
|
#[TestDox('build() succeeds without a custom ReferenceHandler (uses default)')]
|
|
public function testBuildWithoutCustomReferenceHandler(): void
|
|
{
|
|
$server = Server::builder()
|
|
->setServerInfo('test', '1.0.0')
|
|
->build();
|
|
|
|
$this->assertInstanceOf(Server::class, $server);
|
|
}
|
|
|
|
#[TestDox('Custom ReferenceHandler is used when calling a tool')]
|
|
public function testCustomReferenceHandlerIsUsedForToolCalls(): void
|
|
{
|
|
$referenceHandler = $this->createMock(ReferenceHandlerInterface::class);
|
|
$referenceHandler->expects($this->once())
|
|
->method('handle')
|
|
->willReturnCallback(static function (ElementReference $reference, array $arguments): string {
|
|
return 'intercepted';
|
|
});
|
|
|
|
$server = Server::builder()
|
|
->setServerInfo('test', '1.0.0')
|
|
->setReferenceHandler($referenceHandler)
|
|
->addTool(static fn (): string => 'original', name: 'test_tool', description: 'A test tool')
|
|
->build();
|
|
|
|
$result = $this->callTool($server, 'test_tool');
|
|
|
|
$this->assertSame('intercepted', $result);
|
|
}
|
|
|
|
private function callTool(Server $server, string $toolName): mixed
|
|
{
|
|
$protocol = (new \ReflectionClass($server))->getProperty('protocol')->getValue($server);
|
|
$requestHandlers = (new \ReflectionClass($protocol))->getProperty('requestHandlers')->getValue($protocol);
|
|
|
|
foreach ($requestHandlers as $handler) {
|
|
if ($handler instanceof CallToolHandler) {
|
|
$request = CallToolRequest::fromArray([
|
|
'jsonrpc' => '2.0',
|
|
'method' => 'tools/call',
|
|
'id' => 'test-1',
|
|
'params' => ['name' => $toolName, 'arguments' => []],
|
|
]);
|
|
$session = $this->createStub(SessionInterface::class);
|
|
|
|
$response = $handler->handle($request, $session);
|
|
|
|
if ($response instanceof Response) {
|
|
$content = $response->result->content[0] ?? null;
|
|
|
|
return $content instanceof TextContent ? $content->text : null;
|
|
}
|
|
|
|
$this->fail('Expected Response, got '.$response::class);
|
|
}
|
|
}
|
|
|
|
$this->fail('CallToolHandler not found in request handlers');
|
|
}
|
|
}
|