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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_list

Read-onlyIdempotent

List and filter invoices for a location or company, with pagination, date ranges, status, contact, and search parameters.

Instructions

List invoices API to get list of invoices Endpoint: GET /invoices/ (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices.readonly Pagination params: limit, offset — pass them to page through full result sets.

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": {
      "altId": "<altId>",
      "altType": "<altType>",
      "limit": "<limit>",
      "offset": "<offset>"
    },
    "name": "ghl_invoice_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYeslocation Id / company Id based on altType
endAtNoendAt in YYYY-MM-DD format
limitYesLimit the number of items to return
offsetYesNumber of items to skip
searchNoTo search for an invoice by id / name / email / phoneNo
statusNostatus to be filtered
altTypeYesAlt Type
startAtNostartAt in YYYY-MM-DD format
contactIdNoContact ID for the invoice
sortFieldNoThe field on which sorting should be applied
sortOrderNoThe order of sort which should be applied for the sortField
paymentModeNopayment mode

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 declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so safety is covered. The description adds non-annotation context: the required token class, the OAuth scope, the API version header, and the fact that results are paginated and must be iterated with limit/offset. That is real added value, though it stops short of describing default page size or result ordering.

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

Conciseness3/5

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

Front-loaded with the purpose, which is good, but the first two lines are redundant with each other and with the title ("List invoices" / "API to get list of invoices"). The endpoint/version/source metadata is boilerplate that will not help an agent decide or call correctly, and the useful constraints (auth, scope, pagination) are buried at the tail.

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?

For a 12-parameter read list tool with full schema coverage and no output schema, the definition covers the operationally important extras: auth requirement, scope, version, and pagination. What is thin is the value proposition of the many filters (that combining status/date/contact/search is supported) and any sense of return shape or total-count 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%, so every parameter (altId, altType, search, status, startAt/endAt, contactId, sortField/sortOrder, paymentMode) is already documented in structured data. The description only reinforces limit/offset paging semantics, which is useful but marginal; baseline 3 applies when the schema does the heavy lifting.

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 ("List invoices") and identifies the underlying endpoint, so the agent knows exactly what is returned. However, it never distinguishes this from sibling read tools such as ghl_invoice_get, nor does it mention that the tool supports searching/filtering by status, contact, or date range — capabilities that would clearly separate it from a single-invoice fetch.

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?

Gives concrete preconditions — an Agency or Sub-Account token and the invoices.readonly OAuth scope — which tell the agent whether the call can succeed. It also instructs the agent to pass limit/offset to page through full result sets. But it never says when to choose this list tool over ghl_invoice_get or the schedule/template list siblings.

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