Skip to main content
Glama

whm_server_info

Retrieve WHM server details including hostname, OS, cPanel version, load, and uptime for a specified account.

Instructions

Get WHM server information: hostname, OS, cPanel version, load, uptime

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountYesAccount alias from accounts.json (use list_accounts to see options)

Implementation Reference

  • Tool definition (schema) for whm_server_info: name, description, and input schema requiring an 'account' parameter.
    name="whm_server_info",
    description="Get WHM server information: hostname, OS, cPanel version, load, uptime",
    inputSchema={
        "type": "object",
        "properties": ACCOUNT_PARAM,
        "required": ["account"]
    }
  • Handler for whm_server_info: calls the WHM API 'version' endpoint via _get helper, which returns hostname, OS, cPanel version, load, uptime.
    case "whm_server_info":
        return await _get(client, url("version"), headers)
  • The _get helper function used to execute the HTTP GET request to the WHM API.
    async def _get(client: httpx.AsyncClient, url: str, headers: dict, params: dict = None) -> dict:
        try:
            r = await client.get(url, headers=headers, params=params or {})
            r.raise_for_status()
            return r.json()
        except Exception as e:
            return {"error": str(e)}
  • The _whm_url helper that constructs the WHM API URL for any function (here 'version').
    def _whm_url(account: dict, function: str) -> str:
        host = account["host"]
        port = account.get("port", 2087)
        user = account.get("user", "root")
        return f"https://{host}:{port}/json-api/{function}?api.version=1"
  • src/server.py:47-75 (registration)
    The call_tool handler in server.py that routes tool calls to handle_whm_tool when the name starts with 'whm_'.
    @app.call_tool()
    async def call_tool(name: str, arguments: dict[str, Any]) -> list[TextContent]:
        log.info(f"Tool called: {name} | Args: {json.dumps(arguments)}")
    
        if name == "list_accounts":
            accounts = load_accounts()
            result = [
                {"alias": a, "host": cfg["host"], "type": cfg.get("type","whm")}
                for a, cfg in accounts.items()
            ]
            return [TextContent(type="text", text=json.dumps(result, indent=2))]
    
        account_alias = arguments.get("account")
        if not account_alias:
            return [TextContent(type="text", text="ERROR: 'account' parameter is required. Use list_accounts to see available accounts.")]
    
        account = get_account(account_alias)
        if not account:
            return [TextContent(type="text", text=f"ERROR: Account '{account_alias}' not found. Use list_accounts to see configured accounts.")]
    
        async with httpx.AsyncClient(verify=False, timeout=30) as client:
            if name.startswith("whm_"):
                result = await handle_whm_tool(client, account, name, arguments)
            elif name.startswith("cpanel_"):
                result = await handle_cpanel_tool(client, account, name, arguments)
            else:
                result = {"error": f"Unknown tool: {name}"}
    
        return [TextContent(type="text", text=json.dumps(result, indent=2))]
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must fully disclose behavior. It clearly states the return fields, implying a read operation, but does not explicitly confirm read-only status or mention authentication requirements. This is adequate but not highly transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence that efficiently communicates the tool's purpose and output. No extraneous words or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple information retrieval tool with one parameter and no output schema, the description adequately lists the fields returned, making the tool's usage and result clear.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the parameter description already explains the 'account' field. The tool description adds no further meaning beyond what the schema provides, meeting the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get', identifies the resource 'WHM server information', and lists specific fields (hostname, OS, cPanel version, load, uptime). This is distinct from sibling tools like whm_server_load which is more specific.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives such as whm_server_load. The sibling list contains many similar tools, and the description does not clarify scenarios where this tool is preferred.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/manofsadness/ItchWHMMCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server