commercebird
/
vendor
/
wordpress
/
php-mcp-schema
/
src
/
Server
/
Prompts
/
DTO
/
GetPromptRequest.php
GetPromptRequest.php
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | namespace WP\McpSchema\Server\Prompts\DTO; |
| 6 | |
| 7 | use WP\McpSchema\Common\JsonRpc\DTO\JSONRPCRequest; |
| 8 | use WP\McpSchema\Common\Protocol\Union\ClientRequestInterface; |
| 9 | use WP\McpSchema\Common\Traits\ValidatesRequiredFields; |
| 10 | |
| 11 | /** |
| 12 | * Used by the client to get a prompt provided by the server. |
| 13 | * |
| 14 | * @since 2024-11-05 |
| 15 | * @last-updated 2025-11-25 (modified property: params) |
| 16 | * |
| 17 | * @mcp-domain Server |
| 18 | * @mcp-subdomain Prompts |
| 19 | * @mcp-version 2025-11-25 |
| 20 | */ |
| 21 | class GetPromptRequest extends JSONRPCRequest implements ClientRequestInterface |
| 22 | { |
| 23 | use ValidatesRequiredFields; |
| 24 | |
| 25 | public const METHOD = 'prompts/get'; |
| 26 | |
| 27 | public const DISCRIMINATOR_FIELD = 'method'; |
| 28 | public const DISCRIMINATOR_VALUE = 'prompts/get'; |
| 29 | |
| 30 | /** |
| 31 | * @var \WP\McpSchema\Server\Prompts\DTO\GetPromptRequestParams |
| 32 | */ |
| 33 | protected GetPromptRequestParams $typedParams; |
| 34 | |
| 35 | /** |
| 36 | * @param '2.0' $jsonrpc @since 2025-11-25 |
| 37 | * @param string|number $id @since 2025-11-25 |
| 38 | * @param \WP\McpSchema\Server\Prompts\DTO\GetPromptRequestParams $params @since 2024-11-05 |
| 39 | */ |
| 40 | public function __construct( |
| 41 | string $jsonrpc, |
| 42 | $id, |
| 43 | GetPromptRequestParams $params |
| 44 | ) { |
| 45 | parent::__construct(self::METHOD, $jsonrpc, $id, null); |
| 46 | $this->typedParams = $params; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Creates an instance from an array. |
| 51 | * |
| 52 | * @param array{ |
| 53 | * jsonrpc: '2.0', |
| 54 | * id: string|number, |
| 55 | * method: 'prompts/get', |
| 56 | * params: array<string, mixed>|\WP\McpSchema\Server\Prompts\DTO\GetPromptRequestParams |
| 57 | * } $data |
| 58 | * @phpstan-param array<string, mixed> $data |
| 59 | * @return self |
| 60 | */ |
| 61 | public static function fromArray(array $data): self |
| 62 | { |
| 63 | self::assertRequired($data, ['jsonrpc', 'id', 'params']); |
| 64 | |
| 65 | /** @var '2.0' $jsonrpc */ |
| 66 | $jsonrpc = self::asString($data['jsonrpc']); |
| 67 | |
| 68 | /** @var string|number $id */ |
| 69 | $id = self::asStringOrNumber($data['id']); |
| 70 | |
| 71 | /** @var \WP\McpSchema\Server\Prompts\DTO\GetPromptRequestParams $params */ |
| 72 | $params = is_array($data['params']) |
| 73 | ? GetPromptRequestParams::fromArray(self::asArray($data['params'])) |
| 74 | : $data['params']; |
| 75 | |
| 76 | return new self( |
| 77 | $jsonrpc, |
| 78 | $id, |
| 79 | $params |
| 80 | ); |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Converts the instance to an array. |
| 85 | * |
| 86 | * @return array<string, mixed> |
| 87 | */ |
| 88 | public function toArray(): array |
| 89 | { |
| 90 | $result = parent::toArray(); |
| 91 | |
| 92 | $result['params'] = $this->typedParams->toArray(); |
| 93 | |
| 94 | return $result; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * @return \WP\McpSchema\Server\Prompts\DTO\GetPromptRequestParams |
| 99 | */ |
| 100 | public function getTypedParams(): GetPromptRequestParams |
| 101 | { |
| 102 | return $this->typedParams; |
| 103 | } |
| 104 | } |
| 105 |