cPanel/get_wordpress_module
Tool · cPanel

get_wordpress_module

Describe ONE WordPress module in full: every operation with its description, its parameter schema (type, required, allowed values, pattern, bounds) and what it returns. Pass module="sites", "content" or "directory" — matched case-insensitively. Each operation carries three flags worth reading before you call it: access (read or write), destructive (wordpress_manage refuses it without confirm:true) and async (it returns a task_id and is polled with the sites module's operation_status). "requires" says what the operation needs as a target: "service" (service_id only), "installation" (service_id plus installation_id from the sites module's list operation) or "none". error="module_not_found" means no such module; error="module_not_enabled" means JetHost has not switched that module on for this key — both list the modules that ARE available. Call list_wordpress_operations first, this second, wordpress_manage third. Requires the hosting-management scope the customer already granted.

Read-onlyIdempotentOpen‑worldscope cpanel:uapi

Invoked over the MCP transport with a tools/call request naming this tool.

Authorization #

Requires a valid OAuth 2.1 bearer access_token whose grant includes the cpanel:uapi scope — Manage your hosting account via cPanel — read and change settings on the cPanel features JetHost has enabled (this can modify your account). The broker resolves the caller from the token and returns only records the account owns.

Parameters #

modulestringRequired
The WordPress module to describe: "sites" (installations and their lifecycle), "content" (everything inside one installation) or "directory" (search the public plugin/theme catalog). Call list_wordpress_operations first. Matched case-insensitively.

Response #

200 · application/json

discoverystring
One of: live unavailable
modulestring
displayNamestring
summarystring
operation_countinteger
operationsobject
available_modulesarray<string>

Errors #

ResultWhen
{ "error": "internal_error" }See the tool description for when this result is returned.
{ "error": "module_not_found" }The named cPanel module is not enabled on your account. The result lists the available module names.
{ "error": "module_not_enabled" }See the tool description for when this result is returned.