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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_get

Read-onlyIdempotent

Retrieve an invoice by invoice ID and location ID. Use it to fetch GoHighLevel invoice details for a specific agency or sub-account.

Instructions

Get invoice API to get invoice by invoice id Endpoint: GET /invoices/{invoiceId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.readonly

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_get"
  }
}

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 cover the safety profile (readOnlyHint, idempotentHint, non-destructive), so the description earns credit for adding what the annotations don't: the endpoint, the required v3 version header, the token type required, and the invoices.readonly OAuth scope. Missing is any note on failure behavior (e.g., 404 for unknown id) or return shape.

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 purpose is front-loaded and the rest is terse metadata. The line "API to get invoice by invoice id" largely restates the opening sentence, and the "source: v3/invoices-v3.json" fragment is boilerplate, but nothing is verbose.

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?

There is no output schema, so the description could have said what the call returns, and it never explains the altId/altType requirement that the schema leaves implicit. Auth, version header, and scope are covered, which keeps it at minimum-viable rather than worse.

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 the schema already documents invoiceId, altId, and altType. The description mentions the invoice id path parameter but adds nothing about how altId (location/company id) and altType interact, which is the genuinely ambiguous part. 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 plus the retrieval key ("get invoice by invoice id"), which lets an agent distinguish it from ghl_invoice_list and ghl_invoice_create. It does not explicitly contrast with siblings, so it stops short of a 5.

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?

"by invoice id" implies this is the single-record lookup, but the description never says when to use it instead of ghl_invoice_list or what to do if the id is unknown. The auth note ("Requires an Agency or Sub-Account token") is the only actionable guidance.

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