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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_template_update

Idempotent

Update an existing invoice template by ID, including name, business details, currency, items, and discounts. Revise reusable invoice content through the GoHighLevel invoices API.

Instructions

Update template API to update an template by template id Endpoint: PUT /invoices/template/{templateId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/template.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": {
      "templateId": "<templateId>",
      "body": "<body>"
    },
    "name": "ghl_invoice_template_update"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / businessDetails / properties / address / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "addressLine1": {
      -        "description": "Address Line 1",
      -        "example": "9931 Beechwood",
      -        "type": "string"
      -      },
      -      "addressLine2": {
      -        "description": "Address Line 2",
      -        "example": "Beechwood",
      -        "type": "string"
      -      },
      -      "city": {
      -        "description": "City",
      -        "example": "St. Houston",
      -        "type": "string"
      -      },
      -      "countryCode": {
      -        "description": "Country Code",
      -        "example": "US",
      -        "type": "string"
      -      },
      -      "postalCode": {
      -        "description": "Postal Code",
      -        "example": "559-6993",
      -        "type": "string"
      -      },
      -      "state": {
      -        "description": "State",
      -        "example": "TX",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "addressLine1": {
      +        "description": "Address Line 1",
      +        "example": "9931 Beechwood",
      +        "type": "string"
      +      },
      +      "addressLine2": {
      +        "description": "Address Line 2",
      +        "example": "Beechwood",
      +        "type": "string"
      +      },
      +      "city": {
      +        "description": "City",
      +        "example": "St. Houston",
      +        "type": "string"
      +      },
      +      "countryCode": {
      +        "description": "Country Code",
      +        "example": "US",
      +        "type": "string"
      +      },
      +      "postalCode": {
      +        "description": "Postal Code",
      +        "example": "559-6993",
      +        "type": "string"
      +      },
      +      "state": {
      +        "description": "State",
      +        "example": "TX",
      +        "type": "string"
      +      }
      +    },
      +    "title": "AddressDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / businessDetails / title
      Added value: +"BusinessDetailsDto"
    • addedInput schema / properties / body / properties / discount / title
      Added value: +"DiscountDto"
    • addedInput schema / properties / body / properties / items / items / properties / taxes / items / title
      Added value: +"ItemTaxDto"
    • addedInput schema / properties / body / properties / items / items / title
      Added value: +"InvoiceItemDto"
    • changedInput schema / properties / body / properties / miscellaneousCharges / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "charges": {
      -        "description": "charges for the processing fee",
      -        "items": {
      -          "type": "array"
      -        },
      -        "type": "array"
      -      },
      -      "collectedMiscellaneousCharges": {
      -        "description": "collected miscellaneous charges",
      -        "example": 10,
      -        "type": "number"
      -      },
      -      "paidCharges": {
      -        "description": "paid miscellaneous charges",
      -        "items": {
      -          "properties": {
      -            "_id": {
      -              "description": "id of the processing fee",
      -              "example": "673d01d7d547648a8dab6211",
      -              "type": "string"
      -            },
      -            "amount": {
      -              "description": "amount of the processing fee",
      -              "example": 10,
      -              "type": "number"
      -            },
      -            "charge": {
      -              "description": "charge for the processing fee",
      -              "example": 10,
      -              "type": "number"
      -            },
      -            "name": {
      -              "description": "name of the processing fee",
      -              "example": "Processing Fee",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "name",
      -            "charge",
      -            "amount",
      -            "_id"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "charges"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "charges": {
      +        "description": "charges for the processing fee",
      +        "items": {
      +          "type": "array"
      +        },
      +        "type": "array"
      +      },
      +      "collectedMiscellaneousCharges": {
      +        "description": "collected miscellaneous charges",
      +        "example": 10,
      +        "type": "number"
      +      },
      +      "paidCharges": {
      +        "description": "paid miscellaneous charges",
      +        "items": {
      +          "properties": {
      +            "_id": {
      +              "description": "id of the processing fee",
      +              "example": "673d01d7d547648a8dab6211",
      +              "type": "string"
      +            },
      +            "amount": {
      +              "description": "amount of the processing fee",
      +              "example": 10,
      +              "type": "number"
      +            },
      +            "charge": {
      +              "description": "charge for the processing fee",
      +              "example": 10,
      +              "type": "number"
      +            },
      +            "name": {
      +              "description": "name of the processing fee",
      +              "example": "Processing Fee",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "charge",
      +            "amount",
      +            "_id"
      +          ],
      +          "title": "ProcessingFeePaidChargeDto",
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "charges"
      +    ],
      +    "title": "ProcessingFeeDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateInvoiceTemplateDto"
  2. First observedv2.0.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, openWorldHint=true, so the safety profile is covered. The description adds auth level and OAuth scope plus API version header, which is real value. However it omits a key behavioral question for a PUT on a nested object body: whether omitted fields (discount, termsNotes, internal) are wiped or preserved.

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

Conciseness1/5

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

Front-loaded with the verb and verified. Backend implementation details follow: endpoint path, version header, and an internal source file path (v3/invoices-v3.json) that is meaningless to an agent choosing a tool. Low on fluff overall, but the boilerplate dilutes the selection signal.

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

Completeness3/5

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

For a complex nested-body mutation with 100% schema coverage and no output schema, the description covers endpoint, auth, scope, and nothing about response or partial-update semantics. Adequate to invoke, not adequate to predict behavior.

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%, including per-field descriptions and examples for the nested DTO, so the schema carries parameter meaning. The description mentions only templateId (as a path parameter) and says nothing about which body fields are required or how the nested items array behaves; baseline 3 applies.

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 and resource: update an invoice template identified by templateId, plus the underlying PUT endpoint. It is distinguishable from generic siblings like ghl_invoice_template_get/create/delete, but it does not differentiate from the more specific template siblings (update_late_fees_configuration, update_payment_methods_configuration), so an agent must infer that this tool edits the template's core body.

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

Usage Guidelines3/5

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

No explicit when-to-use or when-not-to-use guidance and no named alternatives. The one genuinely useful usage constraint is the prerequisite: an Agency or Sub-Account token and the invoices/template.write scope, which tells the agent this call will fail under a plain location token.

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