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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_text2pay

Creates or updates text2pay invoices for a GoHighLevel sub-account, then sends them or saves them as drafts using specified contact and line-item details.

Instructions

Create & Send API to create or update a text2pay invoice Endpoint: POST /invoices/text2pay (Version header: v3; source: v3/invoices-v3.json) Requires a Sub-Account (location) 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": {
      "body": "<body>"
    },
    "name": "ghl_invoice_text2pay"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed14 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / attachments / items / title
      Added value: +"AttachmentsDto"
    • 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"
    • changedInput schema / properties / body / properties / contactDetails / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "additionalEmails": {
      -        "description": "Secondary email addresses for the contact to be saved",
      -        "items": {
      -          "properties": {
      -            "email": {
      -              "example": "alex@example.com",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "email"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      },
      -      "address": {
      -        "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"
      -      },
      -      "companyName": {
      -        "description": "Contact Company Name",
      -        "example": "ABC Corp.",
      -        "type": "string"
      -      },
      -      "customFields": {
      -        "description": "Custom Values",
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "email": {
      -        "description": "Contact Email",
      -        "example": "alex@example.com",
      -        "type": "string"
      -      },
      -      "id": {
      -        "description": "Contact ID",
      -        "example": "6578278e879ad2646715ba9c",
      -        "type": "string"
      -      },
      -      "name": {
      -        "description": "Contact Name",
      -        "example": "Alex",
      -        "type": "string"
      -      },
      -      "phoneNo": {
      -        "description": "Contact Phone Number",
      -        "example": "+1234567890",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "id",
      -      "name",
      -      "phoneNo",
      -      "email"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "additionalEmails": {
      +        "description": "Secondary email addresses for the contact to be saved",
      +        "items": {
      +          "properties": {
      +            "email": {
      +              "example": "alex@example.com",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "email"
      +          ],
      +          "title": "AdditionalEmailsDto",
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "address": {
      +        "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"
      +      },
      +      "companyName": {
      +        "description": "Contact Company Name",
      +        "example": "ABC Corp.",
      +        "type": "string"
      +      },
      +      "customFields": {
      +        "description": "Custom Values",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "email": {
      +        "description": "Contact Email",
      +        "example": "alex@example.com",
      +        "type": "string"
      +      },
      +      "id": {
      +        "description": "Contact ID",
      +        "example": "6578278e879ad2646715ba9c",
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "Contact Name",
      +        "example": "Alex",
      +        "type": "string"
      +      },
      +      "phoneNo": {
      +        "description": "Contact Phone Number",
      +        "example": "+1234567890",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "name",
      +      "phoneNo",
      +      "email"
      +    ],
      +    "title": "ContactDetailsDto",
      +    "type": "object"
      +  }
      +]
    • 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 / lateFeesConfiguration / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "enable": {
      -        "description": "Enable late fees",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "frequency": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "interval": {
      -                "description": "Late fees interval",
      -                "enum": [
      -                  "minute",
      -                  "hour",
      -                  "day",
      -                  "week",
      -                  "month",
      -                  "one_time"
      -                ],
      -                "example": "day",
      -                "type": "string"
      -              },
      -              "intervalCount": {
      -                "description": "Late fees interval count",
      -                "example": 10,
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "intervalCount",
      -              "interval"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Late Fees Frequency"
      -      },
      -      "grace": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "interval": {
      -                "description": "Late fees grace interval",
      -                "enum": [
      -                  "day"
      -                ],
      -                "example": "day",
      -                "type": "string"
      -              },
      -              "intervalCount": {
      -                "description": "Late fees grace interval count",
      -                "example": 10,
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "intervalCount",
      -              "interval"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Late Fees Grace"
      -      },
      -      "maxLateFees": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "type": {
      -                "enum": [
      -                  "fixed"
      -                ],
      -                "example": "fixed",
      -                "type": "string"
      -              },
      -              "value": {
      -                "description": "Max late fees to pay",
      -                "example": "10",
      -                "type": "number"
      -              }
      -            },
      -            "required": [
      -              "type",
      -              "value"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Max late fees payable"
      -      },
      -      "type": {
      -        "description": "Late Fees Type",
      -        "enum": [
      -          "fixed",
      -          "percentage"
      -        ],
      -        "example": "fixed",
      -        "type": "string"
      -      },
      -      "value": {
      -        "description": "Late Fees Value",
      -        "example": 10,
      -        "type": "number"
      -      }
      -    },
      -    "required": [
      -      "enable",
      -      "value",
      -      "type",
      -      "frequency"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "enable": {
      +        "description": "Enable late fees",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "frequency": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "interval": {
      +                "description": "Late fees interval",
      +                "enum": [
      +                  "minute",
      +                  "hour",
      +                  "day",
      +                  "week",
      +                  "month",
      +                  "one_time"
      +                ],
      +                "example": "day",
      +                "type": "string"
      +              },
      +              "intervalCount": {
      +                "description": "Late fees interval count",
      +                "example": 10,
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "intervalCount",
      +              "interval"
      +            ],
      +            "title": "LateFeesFrequencyDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Late Fees Frequency"
      +      },
      +      "grace": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "interval": {
      +                "description": "Late fees grace interval",
      +                "enum": [
      +                  "day"
      +                ],
      +                "example": "day",
      +                "type": "string"
      +              },
      +              "intervalCount": {
      +                "description": "Late fees grace interval count",
      +                "example": 10,
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "intervalCount",
      +              "interval"
      +            ],
      +            "title": "LateFeesGraceDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Late Fees Grace"
      +      },
      +      "maxLateFees": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "enum": [
      +                  "fixed"
      +                ],
      +                "example": "fixed",
      +                "type": "string"
      +              },
      +              "value": {
      +                "description": "Max late fees to pay",
      +                "example": "10",
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "type",
      +              "value"
      +            ],
      +            "title": "LateFeesMaxFeesDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Max late fees payable"
      +      },
      +      "type": {
      +        "description": "Late Fees Type",
      +        "enum": [
      +          "fixed",
      +          "percentage"
      +        ],
      +        "example": "fixed",
      +        "type": "string"
      +      },
      +      "value": {
      +        "description": "Late Fees Value",
      +        "example": 10,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "enable",
      +      "value",
      +      "type",
      +      "frequency"
      +    ],
      +    "title": "LateFeesConfigurationDto",
      +    "type": "object"
      +  }
      +]
    • 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"
      +  }
      +]
    • changedInput schema / properties / body / properties / paymentMethods / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "stripe": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "enableBankDebitOnly": {
      -                "description": "Enable Bank Debit Only",
      -                "example": false,
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "enableBankDebitOnly"
      -            ],
      -            "type": "object"
      -          }
      -        ],
      -        "description": "Payment Method"
      -      }
      -    },
      -    "required": [
      -      "stripe"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "stripe": {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "enableBankDebitOnly": {
      +                "description": "Enable Bank Debit Only",
      +                "example": false,
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "enableBankDebitOnly"
      +            ],
      +            "title": "StripePaymentMethodDto",
      +            "type": "object"
      +          }
      +        ],
      +        "description": "Payment Method"
      +      }
      +    },
      +    "required": [
      +      "stripe"
      +    ],
      +    "title": "PaymentMethodDto",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / paymentSchedule / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "schedules": {
      -        "description": "payment schedule item",
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "type": {
      -        "description": "Payment schedule type",
      -        "enum": [
      -          "fixed",
      -          "percentage"
      -        ],
      -        "example": "percentage",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "schedules"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "schedules": {
      +        "description": "payment schedule item",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "type": {
      +        "description": "Payment schedule type",
      +        "enum": [
      +          "fixed",
      +          "percentage"
      +        ],
      +        "example": "percentage",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "schedules"
      +    ],
      +    "title": "PaymentScheduleDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / sentTo / title
      Added value: +"SentToDto"
    • changedInput schema / properties / body / properties / tipsConfiguration / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "tipsEnabled": {
      -        "description": "Tips enabled status",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "tipsPercentage": {
      -        "description": "Percentage of tips allowed",
      -        "example": [
      -          5,
      -          10,
      -          15
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "tipsPercentage",
      -      "tipsEnabled"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "tipsEnabled": {
      +        "description": "Tips enabled status",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "tipsPercentage": {
      +        "description": "Percentage of tips allowed",
      +        "example": [
      +          5,
      +          10,
      +          15
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "tipsPercentage",
      +      "tipsEnabled"
      +    ],
      +    "title": "TipsConfigurationDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"Text2PayDto"
  2. 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 declare non-read-only, non-idempotent, non-destructive, open-world behavior; the description adds genuinely useful context beyond them: the write scope required, the location-token requirement, and that a supplied id turns the operation into an update. It stops short of saying what happens when action='send' (email/SMS delivery) or what the call returns.

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?

Front-loads the verb and resource, then layers endpoint, auth, and scope in a few short lines with no filler. Minor redundancy between the title 'Create & Send' and the 'create or update' line, and the embedded source-file metadata is noise for an agent.

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?

Given the very large nested request schema and the absence of an output schema, the description covers the invocation side adequately but says nothing about the response, invoice/link retrieval, or the delivery side effects of sending. For a mutation tool with open-world effects, that leaves a meaningful gap.

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?

There is only one top-level body parameter and schema description coverage is 100%, including the critical 'id of invoice to update' and the action enum, so the schema carries the load. The description contributes nothing further about body contents, so the baseline of 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: 'create or update a text2pay invoice', with the endpoint POST /invoices/text2pay. The gap is that 'text2pay' is never explained and it does not distinguish itself from close siblings like ghl_invoice_create, ghl_invoice_update, or ghl_invoice_send, leaving the agent to infer what makes this invoice type different.

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?

Provides useful prerequisites ('Requires a Sub-Account (location) token', 'OAuth scopes: invoices.write') and implies the create-vs-update branch. However it gives no explicit when-to-use guidance relative to the sibling invoice tools, so the agent has no stated rule for choosing this over ghl_invoice_create or ghl_invoice_send.

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