Skip to main content
Glama

Get Domain WHOIS

whmcs_get_domain_whois

Retrieve WHOIS information for a domain by providing the domain ID.

Instructions

Get WHOIS information for a domain

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainidYesDomain ID

Implementation Reference

  • src/index.ts:659-674 (registration)
    Registration of the 'whmcs_get_domain_whois' tool via server.registerTool, defining its name, title, description, input schema (domainid), and the handler that calls whmcsClient.getDomainWhoisInfo().
    server.registerTool(
        'whmcs_get_domain_whois',
        {
            title: 'Get Domain WHOIS',
            description: 'Get WHOIS information for a domain',
            inputSchema: {
                domainid: z.number().describe('Domain ID'),
            },
        },
        async (params) => {
            const result = await whmcsClient.getDomainWhoisInfo(params);
            return {
                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
            };
        }
    );
  • Input schema for the tool: expects a single 'domainid' (number) parameter.
    inputSchema: {
        domainid: z.number().describe('Domain ID'),
    },
  • Handler function that executes the tool logic — calls whmcsClient.getDomainWhoisInfo(params) and returns the result as JSON text content.
    async (params) => {
        const result = await whmcsClient.getDomainWhoisInfo(params);
        return {
            content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
        };
    }
  • The getDomainWhoisInfo method on WhmcsApiClient. Makes a 'DomainWhois' API call to WHMCS with the domainid, returning WHOIS contact data (registrant, admin, tech, billing) mapped to typed Record<string, string> objects.
    /**
     * Get domain WHOIS info
     */
    async getDomainWhoisInfo(params: { domainid: number }) {
        return this.call<WhmcsApiResponse & {
            status: string;
            domain: {
                registrant: Record<string, string>;
                admin: Record<string, string>;
                tech: Record<string, string>;
                billing: Record<string, string>;
            };
        }>('DomainWhois', params);
    }
Behavior1/5

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

No annotations are present, and the description does not disclose any behavioral traits such as read-only nature, authentication requirements, rate limits, or output characteristics. The agent is left uninformed about the tool's behavior.

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 a single sentence with 7 words, which is concise but lacks substantive information. It does not earn its place as it provides minimal value.

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

Completeness1/5

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

With no annotations and no output schema, the description should ideally explain what WHOIS information is returned. It fails to do so, making it incomplete for an agent to understand the tool's output.

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% with one parameter 'domainid' described as 'Domain ID'. The description adds no additional meaning beyond the schema, so the baseline score of 3 is appropriate.

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 states 'Get WHOIS information for a domain' which is a clear verb and resource. It distinguishes itself from sibling tools like whmcs_get_domain_lock_status and whmcs_get_domain_nameservers by focusing on WHOIS. However, it does not specify the exact scope of WHOIS data.

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

Usage Guidelines1/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, when-not to use, or comparisons with sibling tools.

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