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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_delete

DestructiveIdempotent

Deletes an invoice by invoice ID for a specified location, removing it from the GoHighLevel account when the invoice is no longer needed.

Instructions

Delete invoice API to delete invoice by invoice id Endpoint: DELETE /invoices/{invoiceId} (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>",
      "altId": "<altId>",
      "altType": "<altType>"
    },
    "name": "ghl_invoice_delete"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYeslocation Id / company Id based on altType
altTypeYesAlt Type
invoiceIdYesInvoice Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true, idempotentHint=true and readOnlyHint=false, so the safety posture is covered structurally. The description adds real value beyond that: required token type (Agency or Sub-Account) and the invoices.write OAuth scope, both of which affect whether the call will succeed. It does not state whether deletion is permanent or what happens to paid/issued invoices.

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?

Short and front-loaded: action first, then endpoint, then auth. Minor redundancy between the title-like first line and the second line, but no filler sentences.

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

Completeness5/5

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

For a 3-param destructive endpoint with full schema coverage and explicit destructive annotations, the description supplies the remaining essentials: HTTP endpoint, API version, token type and OAuth scope. There is no output schema to explain, and irreversibility is already declared by annotations.

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%, so invoiceId, altId and altType are already documented in the schema. The description only echoes the invoiceId concept ('by invoice id') and adds nothing about altType/altId scoping. Baseline 3 applies when the schema carries the parameter burden.

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?

States a specific verb+resource ('Delete invoice ... by invoice id') and pins it down with the underlying endpoint DELETE /invoices/{invoiceId}. An agent can distinguish it from get/update/void siblings by name and verb. It stops short of explicitly contrasting with ghl_invoice_void, which is the nearest semantic alternative.

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 when-to-use or when-not-to-use guidance is given. The description never says how this differs from ghl_invoice_void (soft-cancel) or from archiving/updating, so an agent must infer that this is a hard delete rather than a reversible one.

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