Skip to main content
Glama

Get Client Details

whmcs_get_client_details

Retrieve detailed client information using client ID or email, with optional statistics for account management.

Instructions

Get detailed information about a specific client

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
clientidNoThe client ID to retrieve
emailNoThe email address to search for
statsNoInclude client statistics

Implementation Reference

  • src/index.ts:71-88 (registration)
    Tool registration for 'whmcs_get_client_details' using server.registerTool with name 'whmcs_get_client_details', input schema (clientid, email, stats), and handler that calls whmcsClient.getClientDetails(params).
    server.registerTool(
        'whmcs_get_client_details',
        {
            title: 'Get Client Details',
            description: 'Get detailed information about a specific client',
            inputSchema: {
                clientid: z.number().optional().describe('The client ID to retrieve'),
                email: z.string().optional().describe('The email address to search for'),
                stats: z.boolean().optional().describe('Include client statistics'),
            },
        },
        async (params) => {
            const result = await whmcsClient.getClientDetails(params);
            return {
                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
            };
        }
    );
  • The actual handler method getClientDetails on the WhmcsApiClient class. Makes a 'GetClientsDetails' API call to WHMCS with params (clientid?, email?, stats?) and returns typed response including full client details (name, address, status, credit, etc.).
    /**
     * Get details about a specific client
     */
    async getClientDetails(params: {
        clientid?: number;
        email?: string;
        stats?: boolean;
    }) {
        return this.call<WhmcsApiResponse & {
            client: {
                id: number;
                firstname: string;
                lastname: string;
                fullname: string;
                companyname: string;
                email: string;
                address1: string;
                address2: string;
                city: string;
                state: string;
                postcode: string;
                country: string;
                phonenumber: string;
                status: string;
                credit: string;
                taxexempt: boolean;
                latefeeoveride: boolean;
                overideduenotices: boolean;
                separateinvoices: boolean;
                disableautocc: boolean;
                emailoptout: boolean;
                overrideautoclose: boolean;
                allowSingleSignOn: number;
                language: string;
                lastlogin: string;
                currency_id: number;
                notes: string;
            };
        }>('GetClientsDetails', params);
    }
  • Input schema definition for whmcs_get_client_details: clientid (optional number), email (optional string), stats (optional boolean).
    inputSchema: {
        clientid: z.number().optional().describe('The client ID to retrieve'),
        email: z.string().optional().describe('The email address to search for'),
        stats: z.boolean().optional().describe('Include client statistics'),
    },
  • TypeScript parameter type definition for getClientDetails method: clientid?, email?, stats?.
    async getClientDetails(params: {
        clientid?: number;
        email?: string;
        stats?: boolean;
    }) {
Behavior2/5

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

No annotations provided. Description does not disclose read-only nature, required permissions, or what constitutes 'detailed information'. Agents have no behavioral clues beyond the vague description.

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 of 9 words, no redundancy. Front-loads the purpose with no wasted text. Highly concise.

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?

No output schema, no description of return values or side effects. For a data retrieval tool, the description should at least hint at the output structure or scoping, which is missing.

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?

Input schema covers all 3 parameters with descriptions (100% coverage). Description adds no additional meaning beyond schema, warranting baseline score of 3.

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?

Description clearly states verb 'get' and resource 'detailed information about a specific client'. It is specific but does not differentiate from sibling 'whmcs_get_clients' which also retrieves client data.

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 on when to use this tool vs alternatives like whmcs_get_clients or whmcs_get_client_products. Lacks context on prerequisites or typical use cases.

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