cPanel/get_cpanel_module
Tool · cPanel

get_cpanel_module

Describe ONE cPanel module. Pass module (e.g. "DNS", "Email", "Mysql") — call list_cpanel_operations first to see the available module names; the name is matched case-insensitively (an ambiguous case-only match, e.g. both "SSH" and "ssh", returns error="module_ambiguous" with the candidates). By default returns a compact `listing`: one line per function, "name(params) — summary", where a leading "!" marks a MUTATING function (confirm with the user before running one via cpanel_uapi) and a leading space marks a read-only one. Pass `function` (one name, or an array of names, e.g. "list_pops" or ["list_pops","add_pop"]) to instead get the full parameter schema (method, summary, description, params: name/type/required/description) for just those functions. If the module is not enabled, the result lists the available module names so you can correct it. Use this after list_cpanel_operations and before cpanel_uapi to discover a module's exact functions and parameters. Requires the cpanel:uapi scope.

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 cPanel UAPI module to describe, e.g. "DNS", "Email", or "Mysql". Call list_cpanel_operations first to see the available module names. Matched case-insensitively.
functionanyOptional
Optional function name, or array of function names, within the module to fetch full parameter schemas for (e.g. "list_pops" or ["list_pops", "add_pop"]), instead of the default compact listing.

Response #

200 · application/json

discoverystring
One of: live unavailable
modulestring
displayNamestring
function_countinteger
legendstring
listingstring
functionsobject
unmatched_functionsarray<string>
requestedstring
available_modulesarray<string>
candidatesarray<string>

Errors #

ResultWhen
{ "error": "module_ambiguous" }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.