whmcs_get_activity_log
Retrieve system activity logs from WHMCS with filtering options for user, date, IP address, and description to monitor administrative actions.
Instructions
Get system activity log
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limitstart | No | Starting offset | |
| limitnum | No | Number of results | |
| userid | No | Filter by user ID | |
| date | No | Filter by date | |
| user | No | Filter by user | |
| description | No | Filter by description | |
| ipaddress | No | Filter by IP address |
Implementation Reference
- src/whmcs-client.ts:1237-1259 (handler)The handler implementation for whmcs_get_activity_log, which calls the WHMCS API action 'GetActivityLog' with provided parameters and returns the formatted response.async getActivityLog(params: { limitstart?: number; limitnum?: number; userid?: number; date?: string; user?: string; description?: string; ipaddress?: string; } = {}) { return this.call<WhmcsApiResponse & { totalresults: number; startnumber: number; numreturned: number; activity: { entry: Array<{ id: number; date: string; user: string; description: string; ipaddress: string; userid: number; }> }; }>('GetActivityLog', params); }
- src/index.ts:1044-1064 (registration)Registers the 'whmcs_get_activity_log' tool in the MCP server, including input schema validation using Zod and the execution handler that invokes the WhmcsApiClient method.'whmcs_get_activity_log', { title: 'Get Activity Log', description: 'Get system activity log', inputSchema: { limitstart: z.number().optional().describe('Starting offset'), limitnum: z.number().optional().describe('Number of results'), userid: z.number().optional().describe('Filter by user ID'), date: z.string().optional().describe('Filter by date'), user: z.string().optional().describe('Filter by user'), description: z.string().optional().describe('Filter by description'), ipaddress: z.string().optional().describe('Filter by IP address'), }, }, async (params) => { const result = await whmcsClient.getActivityLog(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } );
- src/index.ts:1049-1056 (schema)Input schema definition for the whmcs_get_activity_log tool using Zod, specifying optional parameters for filtering the activity log.limitstart: z.number().optional().describe('Starting offset'), limitnum: z.number().optional().describe('Number of results'), userid: z.number().optional().describe('Filter by user ID'), date: z.string().optional().describe('Filter by date'), user: z.string().optional().describe('Filter by user'), description: z.string().optional().describe('Filter by description'), ipaddress: z.string().optional().describe('Filter by IP address'), },