Make request classes final and update getParams return types for improved type safety

(cherry picked from commit d6be496)

Author: markinigor

src/Schema/JsonRpc/Request.php

@@ -97,7 +97,7 @@ public function jsonSerialize(): array
     }
 
     /**
-     * @return array<string, mixed>|null
+     * @return array<non-empty-string, mixed>|null
      */
     abstract protected function getParams(): ?array;
 }

src/Schema/Request/CallToolRequest.php

@@ -19,7 +19,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class CallToolRequest extends Request
+final class CallToolRequest extends Request
 {
     /**
      * @param string               $name      the name of the tool to invoke
@@ -58,7 +58,10 @@ protected static function fromParams(?array $params): static
         );
     }
 
-    protected function getParams(): ?array
+    /**
+     * @return array{name: string, arguments: array<string, mixed>}
+     */
+    protected function getParams(): array
     {
         return [
             'name' => $this->name,

src/Schema/Request/CompletionCompleteRequest.php

@@ -21,7 +21,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class CompletionCompleteRequest extends Request
+final class CompletionCompleteRequest extends Request
 {
     /**
      * @param PromptReference|ResourceReference    $ref      the prompt or resource to complete
@@ -57,7 +57,13 @@ protected static function fromParams(?array $params): static
         return new self($ref, $params['argument']);
     }
 
-    protected function getParams(): ?array
+    /**
+     * @return array{
+     *     ref: PromptReference|ResourceReference,
+     *     argument: array{ name: string, value: string }
+     * }
+     */
+    protected function getParams(): array
     {
         return [
             'ref' => $this->ref,

src/Schema/Request/CreateSamplingMessageRequest.php

@@ -23,7 +23,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class CreateSamplingMessageRequest extends Request
+final class CreateSamplingMessageRequest extends Request
 {
     /**
      * @param SamplingMessage[]     $messages       the messages to send to the model
@@ -86,7 +86,19 @@ protected static function fromParams(?array $params): static
         );
     }
 
-    protected function getParams(): ?array
+    /**
+     * @return array{
+     *     messages: SamplingMessage[],
+     *     maxTokens: int,
+     *     preferences?: ModelPreferences,
+     *     systemPrompt?: string,
+     *     includeContext?: string,
+     *     temperature?: float,
+     *     stopSequences?: string[],
+     *     metadata?: array<string, mixed>
+     * }
+     */
+    protected function getParams(): array
     {
         $params = [
             'messages' => $this->messages,

src/Schema/Request/GetPromptRequest.php

@@ -19,7 +19,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class GetPromptRequest extends Request
+final class GetPromptRequest extends Request
 {
     /**
      * @param string                    $name      the name of the prompt to get
@@ -55,7 +55,10 @@ protected static function fromParams(?array $params): static
         return new self($params['name'], $arguments);
     }
 
-    protected function getParams(): ?array
+    /**
+     * @return array{name: string, arguments?: array<string, mixed>}
+     */
+    protected function getParams(): array
     {
         $params = ['name' => $this->name];
 

src/Schema/Request/InitializeRequest.php

@@ -21,7 +21,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class InitializeRequest extends Request
+final class InitializeRequest extends Request
 {
     /**
      * @param string             $protocolVersion The latest version of the Model Context Protocol that the client supports. The client MAY decide to support older versions as well.
@@ -59,7 +59,10 @@ protected static function fromParams(?array $params): static
         return new self($params['protocolVersion'], $capabilities, $clientInfo);
     }
 
-    protected function getParams(): ?array
+    /**
+     * @return array{protocolVersion: string, capabilities: ClientCapabilities, clientInfo: Implementation}
+     */
+    protected function getParams(): array
     {
         return [
             'protocolVersion' => $this->protocolVersion,

src/Schema/Request/ListPromptsRequest.php

@@ -18,7 +18,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class ListPromptsRequest extends Request
+final class ListPromptsRequest extends Request
 {
     /**
      * If provided, the server should return results starting after this cursor.
@@ -40,6 +40,9 @@ protected static function fromParams(?array $params): static
         return new self($params['cursor'] ?? null);
     }
 
+    /**
+     * @return array{cursor:string}|null
+     */
     protected function getParams(): ?array
     {
         $params = [];

src/Schema/Request/ListResourceTemplatesRequest.php

@@ -18,7 +18,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class ListResourceTemplatesRequest extends Request
+final class ListResourceTemplatesRequest extends Request
 {
     /**
      * @param string|null $cursor An opaque token representing the current pagination position.
@@ -40,6 +40,9 @@ protected static function fromParams(?array $params): static
         return new self($params['cursor'] ?? null);
     }
 
+    /**
+     * @return array{cursor:string}|null
+     */
     protected function getParams(): ?array
     {
         $params = [];

src/Schema/Request/ListResourcesRequest.php

@@ -18,7 +18,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class ListResourcesRequest extends Request
+final class ListResourcesRequest extends Request
 {
     /**
      * @param string|null $cursor An opaque token representing the current pagination position.
@@ -40,6 +40,9 @@ protected static function fromParams(?array $params): static
         return new self($params['cursor'] ?? null);
     }
 
+    /**
+     * @return array{cursor:string}|null
+     */
     protected function getParams(): ?array
     {
         $params = [];

src/Schema/Request/ListRootsRequest.php

@@ -24,7 +24,7 @@
  *
  * @author Kyrian Obikwelu <[email protected]>
  */
-class ListRootsRequest extends Request
+final class ListRootsRequest extends Request
 {
     public function __construct(
     ) {