McpRestApiCrud.php•8.74 kB
<?php //phpcs:ignore
/**
* Class McpWordPressRestApi
*
* Registers generic MCP tools for CRUD actions on any WordPress REST API endpoint.
*
* @package Automattic\WordpressMcp\Tools
*/
declare( strict_types=1 );
namespace Automattic\WordpressMcp\Tools;
use Automattic\WordpressMcp\Core\RegisterMcpTool;
use WP_REST_Request;
/**
* Class McpWordPressRestApi
*
* Registers generic MCP tools for CRUD actions on any WordPress REST API endpoint.
*
* @package Automattic\WordpressMcp\Tools
*/
class McpRestApiCrud {
/**
* Constructor.
*/
public function __construct() {
add_action( 'wordpress_mcp_init', array( $this, 'register_tools' ) );
}
/**
* Register generic CRUD tools for a given REST API endpoint.
*
* Example usage: You can extend this to register tools for any custom endpoint.
*/
public function register_tools(): void {
// Check if REST API CRUD tools are enabled in settings.
$settings = get_option( 'wordpress_mcp_settings', array() );
if ( empty( $settings['enable_rest_api_crud_tools'] ) ) {
return;
}
// Example: Register CRUD tools for a custom endpoint '/wp/v2/example'.
// To use for other endpoints, duplicate and adjust the route/method/name/description as needed.
new RegisterMcpTool(
array(
'name' => 'list_api_functions',
'description' => 'List all available WordPress REST API endpoints that support CRUD operations (Create, Read, Update, Delete). Use this first to discover what API functions are available before inspecting or calling them.',
'type' => 'read',
'inputSchema' => array(
'type' => 'object',
),
'callback' => array( $this, 'get_available_tools' ),
'permission_callback' => '__return_true',
'annotations' => array(
'title' => 'List API Functions',
'readOnlyHint' => true,
'openWorldHint' => false,
),
)
);
new RegisterMcpTool(
array(
'name' => 'get_function_details',
'description' => 'Get detailed metadata for a specific WordPress REST API endpoint and HTTP method. Includes available parameters, required fields, authentication needs, and expected response structure. Use this to get the details of a specific function before calling it.',
'type' => 'read',
'inputSchema' => array(
'type' => 'object',
'properties' => array(
'route' => array(
'type' => 'string',
'description' => 'The REST API route (e.g., "/wp/v2/posts", "/wp/v2/users")',
),
'method' => array(
'type' => 'string',
'enum' => array( 'GET', 'POST', 'PATCH', 'DELETE' ),
'description' => 'The HTTP method to retrieve metadata for',
),
),
'required' => array( 'route', 'method' ),
),
'callback' => array( $this, 'get_tool_details' ),
'permission_callback' => '__return_true',
'annotations' => array(
'title' => 'Get Function Details',
'readOnlyHint' => true,
'openWorldHint' => false,
),
)
);
new RegisterMcpTool(
array(
'name' => 'run_api_function',
'description' => 'Execute a specific WordPress REST API function by providing the endpoint route, HTTP method, and any required parameters or request body. Supports standard CRUD operations: GET (read), POST (create), PATCH (update), DELETE (remove). For GET requests, pagination parameters (per_page, page, offset) can be provided either in the "data" object or directly in the route query string (e.g., "/wp/v2/posts?per_page=100").',
'type' => 'action',
'inputSchema' => array(
'type' => 'object',
'properties' => array(
'route' => array(
'type' => 'string',
'description' => 'The REST API route (e.g., "/wp/v2/posts", "/wp/v2/users/123")',
),
'method' => array(
'type' => 'string',
'enum' => array( 'GET', 'POST', 'PATCH', 'DELETE' ),
'description' => 'The HTTP method to use: GET, POST, PATCH, or DELETE',
),
'data' => array(
'type' => 'object',
'description' => 'For POST/PATCH requests: request body payload. For GET/DELETE requests: query parameters (e.g., {"per_page": 100, "page": 2}). Not required for GET or DELETE.',
),
),
'required' => array( 'route', 'method' ),
),
'callback' => array( $this, 'handle_tool_run_request' ),
'permission_callback' => '__return_true',
'annotations' => array(
'title' => 'Run API Function',
'readOnlyHint' => false,
'destructiveHint' => true,
'idempotentHint' => false,
'openWorldHint' => false,
),
)
);
}
/**
* Handle a REST API request.
*
* @param array $data The request data.
* @return array The response data.
*/
public function handle_tool_run_request( array $data ): array {
$route = $data['route'];
$method = $data['method'];
$data = $data['data'] ?? array();
// Parse query parameters from route if they exist (e.g., /wp/v2/posts?per_page=100).
$parsed_route = $route;
$query_params = array();
if ( strpos( $route, '?' ) !== false ) {
$route_parts = explode( '?', $route, 2 );
$parsed_route = $route_parts[0];
$query_string = $route_parts[1];
// Parse query string into array.
parse_str( $query_string, $query_params );
}
// Merge query params from route with data params for GET requests.
if ( 'GET' === $method && ! empty( $data ) ) {
$query_params = array_merge( $query_params, $data );
}
// Get settings to check if operations are enabled.
$settings = get_option( 'wordpress_mcp_settings', array() );
// Check if the method is allowed based on settings.
switch ( $method ) {
case 'DELETE':
if ( empty( $settings['enable_delete_tools'] ) ) {
return array(
'error' => 'Delete operations are disabled in MCP settings.',
'code' => 'operation_disabled',
);
}
break;
case 'POST':
if ( empty( $settings['enable_create_tools'] ) ) {
return array(
'error' => 'Create operations are disabled in MCP settings.',
'code' => 'operation_disabled',
);
}
break;
case 'PATCH':
case 'PUT':
if ( empty( $settings['enable_update_tools'] ) ) {
return array(
'error' => 'Update operations are disabled in MCP settings.',
'code' => 'operation_disabled',
);
}
break;
}
// Create REST request with the cleaned route (without query params).
$rest_request = new WP_REST_Request( $method, $parsed_route );
// Set parameters based on HTTP method.
if ( 'GET' === $method || 'DELETE' === $method ) {
// For GET and DELETE requests, use query parameters.
if ( ! empty( $query_params ) ) {
$rest_request->set_query_params( $query_params );
}
} else {
// For POST, PATCH, PUT requests, use body parameters.
if ( ! empty( $data ) ) {
$rest_request->set_body_params( $data );
}
}
$response = rest_do_request( $rest_request );
return $response->get_data();
}
/**
* Get all routes and methods from the WordPress REST API.
*
* @return array The routes and methods.
*/
public function get_available_tools(): array {
$exact_ignore_routes = array(
'/',
'/batch/v1',
);
$containing_ignore_strings = array(
'oembed',
'autosaves',
'revisions',
'jwt-auth',
);
// Get all routes and methods from the WordPress REST API.
$routes = rest_get_server()->get_routes();
$result = array();
foreach ( $routes as $route => $methods ) {
// Skip if route exactly matches any ignore route.
if ( in_array( $route, $exact_ignore_routes, true ) ) {
continue;
}
// Skip if route contains any of the ignore strings.
foreach ( $containing_ignore_strings as $ignore_string ) {
if ( strpos( $route, $ignore_string ) !== false ) {
continue 2;
}
}
foreach ( $methods as $the_methods ) {
$result[] = array(
'route' => $route,
'method' => key( $the_methods['methods'] ),
);
}
}
return $result;
}
/**
* Get details of a WordPress REST API tool.
*
* @param array $data The request data.
* @return array|null The response data.
*/
public function get_tool_details( array $data ): array {
$route = $data['route'];
$method = $data['method'];
$routes = rest_get_server()->get_routes();
foreach ( $routes as $route => $methods ) {
foreach ( $methods as $method => $args ) {
if ( $route === $route && $method === $method ) {
return $args;
}
}
}
return array();
}
}