Skip to main content
Glama
Yadley
by Yadley

Update Invoice

whmcs_update_invoice

Update an existing invoice by changing its status, dates, notes, payment method, or publish options. Provide the invoice ID to apply modifications through the WHMCS API.

Instructions

Update an existing invoice

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoInvoice date (YYYY-MM-DD)
notesNoInvoice notes
statusNoNew status
duedateNoDue date (YYYY-MM-DD)
publishNoPublish draft invoice
invoiceidYesInvoice ID to update
paymentmethodNoPayment method
publishandsendemailNoPublish and send email

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

C2.5/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, and the description only says 'update', lacking details on side effects, permissions, or constraints like whether an invoice can be updated after being paid.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, which is concise, but it is too short to be fully informative; it sacrifices completeness for brevity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an update tool with 8 parameters and no output schema, the description lacks information on effects, order, allowed transitions, and prerequisites, making it incomplete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the description adds no additional meaning beyond what the input schema already provides for each parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool updates an invoice, but it is generic and does not distinguish from sibling tools like whmcs_create_invoice or whmcs_get_invoice.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives, nor any prerequisites or context for updating invoices.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.