README

A Composer library that retrieves all MCP servers registered in WordPress via the MCP Adapter plugin.

This package is intentionally display-free. It provides typed PHP data objects and an optional REST endpoint. How the data is styled and rendered is entirely up to the consuming plugin.

Requirements

The package works gracefully when MCP Adapter is not active — get_servers() simply returns an empty array and is_adapter_available() returns false.

Installation

composer require wpboilerplate/wpb-mcp-servers-list

Make sure your plugin loads the Jetpack Autoloader (installed alongside this package):

require_once __DIR__ . '/vendor/autoload_packages.php';

This package uses Jetpack Autoloader instead of the standard Composer autoloader to prevent class-version conflicts when multiple plugins require the same package. Always load vendor/autoload_packages.php, not vendor/autoload.php.

Usage

1. Collect server data

MCP Adapter registers servers during rest_api_init at priority 15. You must collect after that:

use WPBoilerplate\McpServersList\McpServersList;

// Option A – one-liner bootstrap (registers the hook automatically)
add_action( 'plugins_loaded', [ McpServersList::class, 'bootstrap' ] );

// Option B – manual hook (more control)
add_action( 'rest_api_init', function () {
    McpServersList::instance()->collect();
}, 20 );

2. Read the data

use WPBoilerplate\McpServersList\McpServersList;

$servers = McpServersList::instance()->get_servers();
// $servers → ServerData[]

foreach ( $servers as $server ) {
    echo $server->get_name();         // "WordPress MCP Server"
    echo $server->get_id();           // "default"
    echo $server->get_version();      // "0.5.0"
    echo $server->get_endpoint_url(); // "https://example.com/wp-json/wp/mcp/v1/mcp"

    foreach ( $server->get_tools() as $tool ) {
        echo $tool->get_name();        // "discover_abilities"
        echo $tool->get_description(); // "..."
    }

    foreach ( $server->get_resources() as $resource ) {
        echo $resource->get_name();
        echo $resource->get_uri();
        echo $resource->get_description();
    }

    foreach ( $server->get_prompts() as $prompt ) {
        echo $prompt->get_name();
        echo $prompt->get_description();
    }
}

3. Optional REST endpoint

Register the built-in endpoint so your admin JS can fetch server data:

use WPBoilerplate\McpServersList\RestEndpoint;

add_action( 'rest_api_init', function () {
    // Default: GET /wp-json/wpb-mcp-servers-list/v1/servers  (requires manage_options)
    RestEndpoint::register();

    // Custom namespace / capability at registration time:
    // RestEndpoint::register( 'read', 'my-plugin/v1', '/mcp-servers' );
}, 20 );

The endpoint is admin-only by default (manage_options). Use the wpb_mcp_servers_list_rest_capability filter to change the required capability at runtime:

// Allow editors to access the endpoint:
add_filter( 'wpb_mcp_servers_list_rest_capability', function ( string $cap ): string {
    return 'edit_posts';
} );

// Allow any logged-in user:
add_filter( 'wpb_mcp_servers_list_rest_capability', function ( string $cap ): string {
    return 'read';
} );

Note: The filter takes precedence over the $capability argument passed to RestEndpoint::register(). Non-admin users always receive a 401 Unauthorized response if neither the argument nor the filter grants them access.

Response shape:

{
    "adapter_available": true,
    "servers": [
        {
            "id": "default",
            "name": "WordPress MCP Server",
            "description": "...",
            "version": "0.5.0",
            "endpoint_url": "https://example.com/wp-json/wp/mcp/v1/mcp",
            "route_namespace": "wp/mcp/v1",
            "route": "/mcp",
            "tools": [
                { "name": "discover_abilities", "description": "..." }
            ],
            "resources": [],
            "prompts": []
        }
    ]
}

4. Check adapter availability

if ( McpServersList::is_adapter_available() ) {
    // MCP Adapter plugin is active
}

API Reference

McpServersList

RestEndpoint

Constants: RestEndpoint::NAMESPACE, RestEndpoint::ROUTE

Filter: wpb_mcp_servers_list_rest_capability — override the required WordPress capability at runtime.

// Default behaviour (administrators only):
// apply_filters( 'wpb_mcp_servers_list_rest_capability', 'manage_options' )

ServerData

ToolData / PromptData

get_name(), get_description(), to_array()

ResourceData

get_name(), get_uri(), get_description(), to_array()

Changelog

See CHANGELOG.md.

License

GPL-2.0-or-later — see LICENSE.