Skip to main content
Glama

Get TLD Pricing

whmcs_get_tld_pricing

Retrieve domain TLD pricing for a specified currency ID. Use this tool to obtain cost data for all top-level domains in your WHMCS system.

Instructions

Get domain TLD pricing information

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
currencyidNoCurrency ID

Implementation Reference

  • src/index.ts:750-765 (registration)
    Tool registration for 'whmcs_get_tld_pricing' in the MCP server. Defines the tool name, title, description, input schema (with optional currencyid), and handler that delegates to whmcsClient.getTLDPricing().
    server.registerTool(
        'whmcs_get_tld_pricing',
        {
            title: 'Get TLD Pricing',
            description: 'Get domain TLD pricing information',
            inputSchema: {
                currencyid: z.number().optional().describe('Currency ID'),
            },
        },
        async (params) => {
            const result = await whmcsClient.getTLDPricing(params);
            return {
                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
            };
        }
    );
  • Input schema for the tool: accepts an optional currencyid parameter of type number.
    inputSchema: {
        currencyid: z.number().optional().describe('Currency ID'),
    },
  • The getTLDPricing() method on WhmcsApiClient. This is the actual handler making the WHMCS API call to 'GetTLDPricing' action. It accepts optional currencyid and returns typed response including currency info and pricing per TLD (register, transfer, renew, addons, grace_period, redemption).
    async getTLDPricing(params: {
        currencyid?: number;
    } = {}) {
        return this.call<WhmcsApiResponse & {
            currency: {
                id: number;
                code: string;
                prefix: string;
                suffix: string;
            };
            pricing: Record<string, {
                categories: string[];
                addons: {
                    dns: boolean;
                    email: boolean;
                    idprotect: boolean;
                };
                register: Record<string, string>;
                transfer: Record<string, string>;
                renew: Record<string, string>;
                grace_period: Record<string, unknown>;
                redemption: Record<string, unknown>;
            }>;
        }>('GetTLDPricing', params);
    }
  • The generic API call helper that getTLDPricing uses. Constructs the WHMCS API URL, sends POST with form-urlencoded auth credentials and action parameters, handles errors, and returns parsed JSON response.
    async call<T extends WhmcsApiResponse>(action: string, params: Record<string, unknown> = {}): Promise<T> {
        const url = `${this.config.apiUrl.replace(/\/$/, '')}/includes/api.php`;
        
        const postData: Record<string, string> = {
            identifier: this.config.apiIdentifier,
            secret: this.config.apiSecret,
            action: action,
            responsetype: 'json',
            ...this.flattenParams(params)
        };
    
        if (this.config.accessKey) {
            postData.accesskey = this.config.accessKey;
        }
    
        const response = await fetch(url, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded',
            },
            body: new URLSearchParams(postData).toString(),
        });
    
        if (!response.ok) {
            throw new Error(`WHMCS API request failed: ${response.status} ${response.statusText}`);
        }
    
        const data = await response.json() as T;
        
        if (data.result === 'error') {
            throw new Error(`WHMCS API error: ${data.message || 'Unknown error'}`);
        }
    
        return data;
Behavior2/5

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

With no annotations, the description must fully disclose behavior. It only states a read operation without details on authentication, rate limits, or what is returned. This is insufficient for an agent to understand side effects or constraints.

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

Conciseness3/5

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

The description is one sentence with no wasteful information, but it is too minimal. While concise, it lacks structure and clarity, failing to earn its place by adding value beyond the tool name.

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?

Given the low complexity (1 optional parameter, no output schema), the description is incomplete. It does not mention the return format, whether it lists all TLDs, or any other contextual details that would aid an agent.

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% for the single parameter 'currencyid', so the description does not need to add much. The description itself does not elaborate on parameter meaning beyond what the schema provides, resulting in a baseline score.

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

Purpose4/5

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

The description clearly states the tool retrieves domain TLD pricing, using a specific verb and resource. However, it does not differentiate from sibling tools like whmcs_get_currencies or whmcs_get_products, which could lead to confusion about scope.

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. There is no mention of prerequisites, typical use cases, or exclusions, leaving the agent without context for appropriate invocation.

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/scarecr0w12/whmcs-mcp-tool'

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