Get Client Domains
whmcs_get_client_domainsRetrieve domains owned by a specific client, with optional filters for domain ID, name, and pagination.
Instructions
Get domains owned by a client
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clientid | No | The client ID | |
| domainid | No | Specific domain ID | |
| domain | No | Filter by domain name | |
| limitstart | No | Starting offset | |
| limitnum | No | Number of results |
Implementation Reference
- src/index.ts:195-214 (registration)Tool registration for whmcs_get_client_domains in the MCP server, defining the tool name, input schema, and handler that delegates to whmcsClient.getClientDomains()
server.registerTool( 'whmcs_get_client_domains', { title: 'Get Client Domains', description: 'Get domains owned by a client', inputSchema: { clientid: z.number().optional().describe('The client ID'), domainid: z.number().optional().describe('Specific domain ID'), domain: z.string().optional().describe('Filter by domain name'), limitstart: z.number().optional().describe('Starting offset'), limitnum: z.number().optional().describe('Number of results'), }, }, async (params) => { const result = await whmcsClient.getClientDomains(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } ); - src/index.ts:200-206 (schema)Input schema definition for the whmcs_get_client_domains tool using Zod validation with optional parameters
inputSchema: { clientid: z.number().optional().describe('The client ID'), domainid: z.number().optional().describe('Specific domain ID'), domain: z.string().optional().describe('Filter by domain name'), limitstart: z.number().optional().describe('Starting offset'), limitnum: z.number().optional().describe('Number of results'), },