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

ghl-mcp-server-v2

by zackscriven

ghl_payment_order_record_payment

Records a manual or offline payment against an order, updates its status to Paid, and does not process a live charge.

Instructions

Records a manual/offline payment against an order. Does not process a live charge. Record Order Payment The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid". Endpoint: POST /payments/orders/{orderId}/record-payment (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.collectPayment

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": {
      "orderId": "<orderId>",
      "body": "<body>"
    },
    "name": "ghl_payment_order_record_payment"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / card / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "last4": {
      -        "description": "Last 4 digit of the card",
      -        "example": "1234",
      -        "type": "string"
      -      },
      -      "type": {
      -        "enum": [
      -          "visa",
      -          "mastercard",
      -          "other"
      -        ],
      -        "example": "mastercard",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "last4"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "last4": {
      +        "description": "Last 4 digit of the card",
      +        "example": "1234",
      +        "type": "string"
      +      },
      +      "type": {
      +        "enum": [
      +          "visa",
      +          "mastercard",
      +          "other"
      +        ],
      +        "example": "mastercard",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "last4"
      +    ],
      +    "title": "CardDto",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / cheque / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "number": {
      -        "description": "check number",
      -        "example": "129-129-129-912",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "number"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "number": {
      +        "description": "check number",
      +        "example": "129-129-129-912",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "number"
      +    ],
      +    "title": "ChequeDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"PostRecordOrderPaymentBody"
  2. First observedv2.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already flag this as a non-read-only, non-destructive, open-world mutation. The description adds real value beyond them: the side effect (order status becomes 'Paid'), the required sub-account token, and the OAuth scope payments/orders.collectPayment. It stops short of warning about retry/duplicate behavior, which matters since idempotentHint is false.

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 key constraint is front-loaded, but the text then repeats itself ('records a payment', 'Record Order Payment', 'allows to record a payment for an order') and carries spec metadata (version header, source file path) that adds little for tool selection.

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 nested-body mutation with no output schema, the description supplies the endpoint, auth requirement, scope, and resulting state change — enough to call it correctly. Missing only edge-case guidance (partial payments, duplicate submissions) that the annotations' idempotentHint=false hints at.

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 orderId and every body field (mode, altId, altType, amount, card, cheque, notes, isPartialPayment) are already documented in the schema. The description adds no syntax or conditional detail on top, so the 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+resource ('Records a manual/offline payment against an order') and explicitly excludes the adjacent concept ('Does not process a live charge'). This differentiates it from live-charge flows, though it does not name the close sibling ghl_invoice_record_payment, so an agent must still infer which record-payment tool applies.

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?

Says when to use it ('record a payment for an order and update the order status to Paid') and supplies a negative condition ('does not process a live charge'). No explicit alternative tool is named, so routing between this and ghl_invoice_record_payment is left to inference.

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