whmcs_get_invoiceRetrieve detailed information for a specific invoice by providing its invoice ID, including line items, totals, and status.
Get detailed information about a specific invoice
| Name | Required | Description | Default |
|---|---|---|---|
| invoiceid | Yes | The invoice ID |
Changes observed during successful MCP inspections.
v1.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must disclose read-only nature, authentication needs, or side effects. Only states 'Get detailed information' without behavioral context.
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, clear and to the point. Minimal but not wasteful.
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, so description should explain what details are returned. Also lacks context among many sibling tools.
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?
Single parameter 'invoiceid' has schema description. Description adds no extra meaning beyond schema, so baseline 3 applies.
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 verb 'Get' and resource 'detailed information about a specific invoice'. It distinguishes from sibling tools like whmcs_get_invoices (list) and whmcs_create_invoice (create).
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 like whmcs_get_invoices or whmcs_create_invoice. No prerequisites or exclusions mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.