Registry Architecture Refactoring - Enhanced Separation of Concerns (#46)

* refactor: Separate Registry concerns following SOLID principles [WIP] - Extract ReferenceProvider and ReferenceRegistryInterface interfaces - Create DefaultToolExecutor with ReferenceHandlerInterface - Remove execution responsibility from Registry class - Enable custom handler and executor implementations * refactor: implement SOLID principles with separated execution concerns * Create DefaultResourceReader, DefaultPromptGetter * Refactor JsonRpc Handler and RequestHandlers to use dedicated executors * Update ServerBuilder to support custom executors via dependency injection * chore: remove extra comments * feat: introduce DispatchableRegistry for enhanced tool and resource management * refactor: use proper interfaces * refactor: implement HandlerInterface for improved abstraction and flexibility * test: add unit tests for DispatchableRegistry and Registry classes * refactor: cover with unit tests Resource reader, Prompt getter and Tool executor * cs fix * phpstan fix * test: add unit tests for CallToolHandler, GetPromptHandler, PingHandler, and ReadResourceHandler * refactor: revert Handler * chore: remove style guide for tests * refactor: remove "Default" prefix from classes * refactor: remove DispatchableRegistry * refactor: use package specific exception classes * refactor: remove DispatchableRegistry * refactor: add logger support to PromptGetter and ResourceReader classes * Update src/Capability/Prompt/PromptGetter.php Co-authored-by: Christopher Hertel <mail@christopher-hertel.de> * refactor: Use FQN for Resource class to avoid cs-fixer misinterpreting it as `resource` * refactor: rename ToolExecutor to ToolCaller and related classes for clarity and consistency * refactor: add missed docblock * refactor: rename ToolExecutor references to ToolCaller * refactor: rename ToolCallerTest property and variable references * cs fix * ignore some phpstan errors --------- Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
2025-09-14 22:44:18 +04:00 · 2025-09-14 22:44:18 +04:00 · 99bf56eef8
commit 99bf56eef8
parent bfc3b82d19
1 changed files with 4656 additions and 334 deletions
--- a/src/Capability/Tool/ToolCaller.php
+++ b/src/Capability/Tool/ToolCaller.php
@ -0,0 +1,81 @@
+<?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\Capability\Tool;
+
+use Mcp\Capability\Registry\ReferenceHandlerInterface;
+use Mcp\Capability\Registry\ReferenceProviderInterface;
+use Mcp\Exception\ToolCallException;
+use Mcp\Exception\ToolNotFoundException;
+use Mcp\Schema\Content\AudioContent;
+use Mcp\Schema\Content\EmbeddedResource;
+use Mcp\Schema\Content\ImageContent;
+use Mcp\Schema\Content\TextContent;
+use Mcp\Schema\Request\CallToolRequest;
+use Mcp\Schema\Result\CallToolResult;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+
+/**
+ * Default implementation of ToolCallerInterface that uses ReferenceProvider
+ * and ReferenceHandlerInterface to execute tools.
+ *
+ * @author Pavel Buchnev <butschster@gmail.com>
+ */
+final class ToolCaller implements ToolCallerInterface
+{
+    public function __construct(
+        private readonly ReferenceProviderInterface $referenceProvider,
+        private readonly ReferenceHandlerInterface $referenceHandler,
+        private readonly LoggerInterface $logger = new NullLogger(),
+    ) {
+    }
+
+    /**
+     * @throws ToolCallException     if the tool execution fails
+     * @throws ToolNotFoundException if the tool is not found
+     */
+    public function call(CallToolRequest $request): CallToolResult
+    {
+        $toolName = $request->name;
+        $arguments = $request->arguments ?? [];
+
+        $this->logger->debug('Executing tool', ['name' => $toolName, 'arguments' => $arguments]);
+
+        $toolReference = $this->referenceProvider->getTool($toolName);
+
+        if (null === $toolReference) {
+            $this->logger->warning('Tool not found', ['name' => $toolName]);
+            throw new ToolNotFoundException($request);
+        }
+
+        try {
+            $result = $this->referenceHandler->handle($toolReference, $arguments);
+            /** @var TextContent[]|ImageContent[]|EmbeddedResource[]|AudioContent[] $formattedResult */
+            $formattedResult = $toolReference->formatResult($result);
+
+            $this->logger->debug('Tool executed successfully', [
+                'name' => $toolName,
+                'result_type' => \gettype($result),
+            ]);
+
+            return new CallToolResult($formattedResult);
+        } catch (\Throwable $e) {
+            $this->logger->error('Tool execution failed', [
+                'name' => $toolName,
+                'exception' => $e->getMessage(),
+                'trace' => $e->getTraceAsString(),
+            ]);
+
+            throw new ToolCallException($request, $e);
+        }
+    }
+}