fb2c8c2ee4* 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>
68 lines
2 KiB
PHP
68 lines
2 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\Capability\Discovery\Fixtures;
|
|
|
|
use Mcp\Capability\Attribute\McpTool;
|
|
use Mcp\Schema\ToolAnnotations;
|
|
use Mcp\Tests\Unit\Fixtures\Enum\BackedStringEnum;
|
|
|
|
class DiscoverableToolHandler
|
|
{
|
|
/**
|
|
* A basic discoverable tool.
|
|
*
|
|
* @param string $name the name to greet
|
|
*
|
|
* @return string the greeting
|
|
*/
|
|
#[McpTool(name: 'greet_user', description: 'Greets a user by name.', title: 'Greet User')]
|
|
public function greet(string $name): string
|
|
{
|
|
return "Hello, {$name}!";
|
|
}
|
|
|
|
/**
|
|
* A tool with more complex parameters and inferred name/description.
|
|
*
|
|
* @param int $count the number of times to repeat
|
|
* @param bool $loudly Should it be loud?
|
|
* @param BackedStringEnum $mode the mode of operation
|
|
*
|
|
* @return array an array with results
|
|
*/
|
|
#[McpTool(annotations: new ToolAnnotations(readOnlyHint: true))]
|
|
public function repeatAction(int $count, bool $loudly = false, BackedStringEnum $mode = BackedStringEnum::OptionA): array
|
|
{
|
|
return ['count' => $count, 'loudly' => $loudly, 'mode' => $mode->value, 'message' => 'Action repeated.'];
|
|
}
|
|
|
|
// This method should NOT be discovered as a tool
|
|
public function internalHelperMethod(int $value): int
|
|
{
|
|
return $value * 2;
|
|
}
|
|
|
|
#[McpTool(name: 'private_tool_should_be_ignored')] // On private method
|
|
private function aPrivateTool(): void
|
|
{
|
|
}
|
|
|
|
#[McpTool(name: 'protected_tool_should_be_ignored')] // On protected method
|
|
protected function aProtectedTool(): void
|
|
{
|
|
}
|
|
|
|
#[McpTool(name: 'static_tool_should_be_ignored')] // On static method
|
|
public static function aStaticTool(): void
|
|
{
|
|
}
|
|
}
|