commercebird
/
vendor
/
wordpress
/
mcp-adapter
/
includes
/
Domain
/
Prompts
/
Contracts
/
McpPromptBuilderInterface.php
commercebird
/
vendor
/
wordpress
/
mcp-adapter
/
includes
/
Domain
/
Prompts
/
Contracts
Last commit date
McpPromptBuilderInterface.php
2 months ago
McpPromptBuilderInterface.php
75 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Interface for MCP Prompt Builders. |
| 4 | * |
| 5 | * @package McpAdapter |
| 6 | */ |
| 7 | |
| 8 | declare( strict_types=1 ); |
| 9 | |
| 10 | namespace WP\MCP\Domain\Prompts\Contracts; |
| 11 | |
| 12 | use WP\McpSchema\Server\Prompts\DTO\Prompt; |
| 13 | |
| 14 | /** |
| 15 | * Interface for building MCP prompts. |
| 16 | * |
| 17 | * Classes implementing this interface can be passed directly to McpServer::register_prompts() |
| 18 | * instead of requiring WordPress abilities. |
| 19 | */ |
| 20 | interface McpPromptBuilderInterface { |
| 21 | |
| 22 | /** |
| 23 | * Build and return the Prompt DTO instance. |
| 24 | * |
| 25 | * @return \WP\McpSchema\Server\Prompts\DTO\Prompt The built prompt DTO. |
| 26 | */ |
| 27 | public function build(): Prompt; |
| 28 | |
| 29 | /** |
| 30 | * Get the unique name for this prompt. |
| 31 | * |
| 32 | * @return string The prompt name. |
| 33 | */ |
| 34 | public function get_name(): string; |
| 35 | |
| 36 | /** |
| 37 | * Get the prompt title. |
| 38 | * |
| 39 | * @return string|null The prompt title. |
| 40 | */ |
| 41 | public function get_title(): ?string; |
| 42 | |
| 43 | /** |
| 44 | * Get the prompt description. |
| 45 | * |
| 46 | * @return string|null The prompt description. |
| 47 | */ |
| 48 | public function get_description(): ?string; |
| 49 | |
| 50 | /** |
| 51 | * Get the prompt arguments. |
| 52 | * |
| 53 | * @return array The prompt arguments. |
| 54 | */ |
| 55 | public function get_arguments(): array; |
| 56 | |
| 57 | /** |
| 58 | * Handle the prompt execution when called. |
| 59 | * |
| 60 | * @param array $arguments The arguments passed to the prompt. |
| 61 | * |
| 62 | * @return array The prompt response. |
| 63 | */ |
| 64 | public function handle( array $arguments ): array; |
| 65 | |
| 66 | /** |
| 67 | * Check if the current user has permission to execute this prompt. |
| 68 | * |
| 69 | * @param array $arguments The arguments passed to the prompt. |
| 70 | * |
| 71 | * @return bool True if execution is allowed, false otherwise. |
| 72 | */ |
| 73 | public function has_permission( array $arguments ): bool; |
| 74 | } |
| 75 |