whmcs_get_ticketsRetrieve support tickets from WHMCS with optional filters like status, client, department, or email to quickly access relevant ticket data.
Get support tickets with optional filtering
| Name | Required | Description | Default |
|---|---|---|---|
| No | Filter by email | ||
| deptid | No | Filter by department ID | |
| status | No | Filter by status | |
| subject | No | Filter by subject | |
| clientid | No | Filter by client ID | |
| limitnum | No | Number of results | |
| limitstart | No | Starting offset |
Changes observed during successful MCP inspections.
v1.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. The description does not disclose any behavioral traits such as authentication needs, rate limits, or pagination behavior. Minimal information beyond the basic function.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence, no wasted words. Efficiently communicates the tool's purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 7 parameters, no output schema, and no annotations, the description is incomplete. It does not explain response format, pagination defaults, or behavior without filters.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with all parameters described. The description adds 'optional filtering' which is already implied by no required params. No additional meaning beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves support tickets with optional filtering. It is distinct from siblings like whmcs_get_ticket (singular) and whmcs_add_ticket_note/reply.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this vs alternatives like whmcs_get_ticket. Does not mention filtering as optional or provide context for parameters.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.