whmcs_get_ordersRetrieve WHMCS orders with optional filters for ID, status, client, and pagination. Get precise order data for reporting or integration.
Get orders with optional filtering
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Specific order ID | |
| status | No | Filter by status | |
| userid | 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 exist, so the description must disclose behavioral traits. It only mentions 'optional filtering' but does not explain pagination behavior (limitstart, limitnum), what is returned for empty queries, or whether it returns all orders by default. Minimal transparency.
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, front-loaded with the verb and resource. Could be slightly more informative (e.g., mention pagination or status), but no wasted words.
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?
No output schema, no annotations, and minimal description. For a tool with 5 optional parameters and many sibling tools, more context (e.g., typical use case, filter options) is needed for an agent to use it effectively.
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%, and the description adds no new meaning beyond the schema's parameter descriptions. Baseline 3 is appropriate.
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 action ('Get orders') and the resource ('orders') with optional filtering, distinguishing it from sibling tools like whmcs_accept_order or whmcs_cancel_order.
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 tool versus alternatives (e.g., whmcs_get_invoices for invoices, or whmcs_get_client_products for products). No mention of prerequisites or when not to use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.