Skip to main content
Glama

whm_backup_list

List available backups for a specified WHM account to verify backup status and plan restores.

Instructions

List available backups on the WHM server

Input Schema

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

Implementation Reference

  • src/tools.py:270-278 (registration)
    Tool registration for whm_backup_list. Defines the name 'whm_backup_list', description 'List available backups on the WHM server', and input schema requiring only the 'account' parameter.
    Tool(
        name="whm_backup_list",
        description="List available backups on the WHM server",
        inputSchema={
            "type": "object",
            "properties": ACCOUNT_PARAM,
            "required": ["account"]
        }
    ),
  • Handler for whm_backup_list tool. Makes a GET request to the WHM JSON API endpoint 'backup_set_up_config' to retrieve backup configuration/listing data.
    case "whm_backup_list":
        return await _get(client, url("backup_set_up_config"), headers)
Behavior2/5

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

With no annotations, the description must disclose behavioral traits. It only states the basic function, omitting details like read-only nature, authentication needs, or output format.

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?

Single sentence, front-loaded, and free of redundancy. Perfectly concise for a simple list operation.

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

Completeness2/5

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

The description is too minimal for a tool with no output schema. It does not clarify that backups are listed per account (implied by required param), nor describe the return format or any limitations.

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?

The schema description for 'account' is clear and provides context (aliases from accounts.json). However, the tool description itself does not elaborate on parameter meaning. With 100% schema coverage, a score of 3 is appropriate.

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 action ('list') and the resource ('available backups on the WHM server'). It is specific and distinct from sibling tools, none of which deal with backups.

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, nor any exclusions or prerequisites. The description assumes the agent knows the context.

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