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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_record_payment

Records a manual or offline payment against an invoice, such as cash or check, without processing a live charge.

Instructions

Records a manual/offline payment against an invoice (e.g. cash, check). Does not process a live charge. Record a manual payment for an invoice API to record manual payment for an invoice by invoice id Endpoint: POST /invoices/{invoiceId}/record-payment (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>",
      "body": "<body>"
    },
    "name": "ghl_invoice_record_payment"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / card / title
      Added value: +"CardDto"
    • addedInput schema / properties / body / properties / cheque / title
      Added value: +"ChequeDto"
    • addedInput schema / properties / body / title
      Added value: +"RecordPaymentDto"
  2. First observedv2.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare the mutation/safety profile (readOnlyHint false, destructiveHint false, idempotentHint false, openWorldHint true), so the description doesn't need to re-litigate that. It adds genuinely useful context annotations can't carry: the endpoint and API version, that an Agency or Sub-Account token is required, and the OAuth scope invoices.write. It does not state how the invoice balance is affected or whether a duplicate record call would double-post the payment.

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?

The leading sentence is well front-loaded, but the next two lines restate the same thing three times ('Record a manual payment for an invoice', 'API to record manual payment for an invoice by invoice id'). That duplication is likely auto-generated metadata rather than authored content and adds no selection value.

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 mutation tool with a deeply nested body and no output schema, the definition covers the essentials an agent needs to attempt the call: endpoint, version header, auth requirement, scope, and the explicit no-live-charge boundary. Gaps are minor — the interaction between amount, paymentScheduleIds and fulfilledAt is left entirely to the schema.

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 including the nested body fields already carries its own description and examples; this is the baseline-3 case. The description adds no parameter-level guidance, and notably doesn't address the schema oddity that card, cheque and notes are all listed as required despite mode being an enum — clarity the schema alone doesn't provide.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('records a manual/offline payment against an invoice') and immediately delimits the operation with 'Does not process a live charge,' which distinguishes it from a normal payment-charge flow. The example payment instruments (cash, check) further pin down what kind of operation this is.

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

Usage Guidelines4/5

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

The exclusion 'Does not process a live charge' tells the agent when this tool does NOT apply, which is the most valuable routing signal here. It stops short of naming an explicit alternative (e.g. the sibling ghl_payment_order_record_payment or a live-charge tool), so it earns a 4 rather than a 5.

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