Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_invoice_void

Marks an invoice as void, preventing payment or reactivation; use it to cancel an invoice irreversibly.

Instructions

Irreversible: marks the invoice as void. A voided invoice cannot be paid or reactivated afterward. Void invoice API to delete invoice by invoice id Endpoint: POST /invoices/{invoiceId}/void (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.write

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "invoiceId": "<invoiceId>",
      "body": "<body>"
    },
    "name": "ghl_invoice_void"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
invoiceIdYesInvoice Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"VoidInvoiceDto"
  2. First observedv2.0.0

TDQS

B3.3/5.0
Behavior1/5

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

The description explicitly declares the operation irreversible ('cannot be paid or reactivated afterward'), yet the annotations declare destructiveHint=false, which per MCP semantics means only additive updates. An irreversible, revenue-blocking state change is not additive, so the two signals conflict and an agent could call this believing it is safely reversible. Otherwise the description is informative (auth requirements, scope, endpoint), but the contradiction is the dominant signal.

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

Conciseness4/5

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

The irreversibility warning is correctly front-loaded ahead of the API metadata, and the sentences are short. The redundant 'Void invoice' title restatement plus the contradictory 'API to delete invoice' line are minor waste that could be cut.

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

Completeness4/5

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

No output schema exists, so the description should carry the behavioral burden, and it does cover consequences, token requirements, scope and endpoint. It omits what happens to the invoice record and any payment links after voiding, and it does not address the nested body, but for a 2-parameter tool the coverage is close to complete.

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 description coverage is 100%, so both invoiceId and the nested body (altId/altType) are already documented in the schema. The description only adds the endpoint path showing invoiceId as a path segment and gives no semantics for the required altId/altType body fields, so it stays at the baseline.

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

Purpose4/5

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

The description gives a specific verb+resource ('marks the invoice as void', POST /invoices/{invoiceId}/void) and is front-loaded with what actually happens. The trailing line 'API to delete invoice by invoice id' is inherited spec boilerplate that blurs the distinction from the sibling ghl_invoice_delete, which is a real delete, so it is clear but not perfectly disambiguated.

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

Usage Guidelines4/5

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

'A voided invoice cannot be paid or reactivated afterward' functions as explicit when-not guidance: do not call this if the invoice should remain collectible. It also names the required token type and OAuth scope, but never routes to an alternative (e.g. ghl_invoice_delete or ghl_invoice_update) when voiding is the wrong action.

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

Deploy Server

Other Tools