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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_set_auto_payment

Configure or update auto-payment settings for a scheduled invoice, including enabling automatic charges and assigning a card or bank payment method.

Instructions

Manage Auto payment for an schedule invoice API to manage auto payment for a schedule Endpoint: POST /invoices/schedule/{scheduleId}/auto-payment (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.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": {
      "scheduleId": "<scheduleId>",
      "body": "<body>"
    },
    "name": "ghl_invoice_schedule_set_auto_payment"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / autoPayment / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "bacsDirectDebit": {
      -        "properties": {
      -          "last4": {
      -            "type": "string"
      -          },
      -          "sort_code": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "sort_code",
      -          "last4"
      -        ],
      -        "type": "object"
      -      },
      -      "becsDirectDebit": {
      -        "properties": {
      -          "bsb_number": {
      -            "type": "string"
      -          },
      -          "last4": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "bsb_number",
      -          "last4"
      -        ],
      -        "type": "object"
      -      },
      -      "card": {
      -        "properties": {
      -          "brand": {
      -            "type": "string"
      -          },
      -          "last4": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "brand",
      -          "last4"
      -        ],
      -        "type": "object"
      -      },
      -      "cardId": {
      -        "type": "string"
      -      },
      -      "customerId": {
      -        "type": "string"
      -      },
      -      "enable": {
      -        "type": "boolean"
      -      },
      -      "paymentMethodId": {
      -        "type": "string"
      -      },
      -      "provider": {
      -        "type": "object"
      -      },
      -      "sepaDirectDebit": {
      -        "properties": {
      -          "bank_code": {
      -            "type": "string"
      -          },
      -          "branch_code": {
      -            "type": "string"
      -          },
      -          "last4": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "bank_code",
      -          "last4",
      -          "branch_code"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "type": "string"
      -      },
      -      "usBankAccount": {
      -        "properties": {
      -          "bank_name": {
      -            "type": "string"
      -          },
      -          "last4": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "bank_name",
      -          "last4"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "enable"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "bacsDirectDebit": {
      +        "properties": {
      +          "last4": {
      +            "type": "string"
      +          },
      +          "sort_code": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "sort_code",
      +          "last4"
      +        ],
      +        "title": "BacsDirectDebitDTO",
      +        "type": "object"
      +      },
      +      "becsDirectDebit": {
      +        "properties": {
      +          "bsb_number": {
      +            "type": "string"
      +          },
      +          "last4": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "bsb_number",
      +          "last4"
      +        ],
      +        "title": "BecsDirectDebitDTO",
      +        "type": "object"
      +      },
      +      "card": {
      +        "properties": {
      +          "brand": {
      +            "type": "string"
      +          },
      +          "last4": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "brand",
      +          "last4"
      +        ],
      +        "title": "CardDto",
      +        "type": "object"
      +      },
      +      "cardId": {
      +        "type": "string"
      +      },
      +      "customerId": {
      +        "type": "string"
      +      },
      +      "enable": {
      +        "type": "boolean"
      +      },
      +      "paymentMethodId": {
      +        "type": "string"
      +      },
      +      "provider": {
      +        "type": "object"
      +      },
      +      "sepaDirectDebit": {
      +        "properties": {
      +          "bank_code": {
      +            "type": "string"
      +          },
      +          "branch_code": {
      +            "type": "string"
      +          },
      +          "last4": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "bank_code",
      +          "last4",
      +          "branch_code"
      +        ],
      +        "title": "SepaDirectDebitDTO",
      +        "type": "object"
      +      },
      +      "type": {
      +        "type": "string"
      +      },
      +      "usBankAccount": {
      +        "properties": {
      +          "bank_name": {
      +            "type": "string"
      +          },
      +          "last4": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "bank_name",
      +          "last4"
      +        ],
      +        "title": "USBankAccountDto",
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "enable"
      +    ],
      +    "title": "AutoPaymentDetailsDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"AutoPaymentScheduleDto"
  2. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, and destructiveHint=false, so the description isn't carrying the safety burden alone. It does add genuinely useful operational context the annotations lack: POST semantics, the required token type, and the exact OAuth scope (invoices/schedule.write), which tells the agent what credentials it needs before calling.

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

Conciseness5/5

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

No, wait — the first two lines are near-duplicates ('Manage Auto payment for an schedule invoice' / 'API to manage auto payment for a schedule'), and the ungrammatical 'an schedule' suggests raw spec boilerplate. The endpoint and OAuth lines are informative but the restatement wastes space.

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 needn't cover returns, and it does disclose auth scope and the endpoint. But for a tool whose body is a deeply nested AutoPaymentScheduleDto (card, bank_account, SEPA/BACS/BECS details, enable flag), the description gives no guidance on body semantics or whether the payload replaces an existing auto-payment setup.

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% and both parameters are documented in the schema, so baseline 3 applies. The description adds only the endpoint path showing where scheduleId is substituted; it says nothing about the nested autoPayment body (enable flag, payment method variants) that the schema alone must convey.

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?

The description names the resource ('Auto payment for a schedule invoice') and the endpoint POST /invoices/schedule/{scheduleId}/auto-payment, which together make clear this writes auto-payment configuration onto a scheduled invoice. That distinguishes it from siblings like ghl_invoice_schedule_update, _activate, and _cancel, though the verb 'manage' is softer than the tool name's 'set'.

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?

No explicit statement of when to use this versus ghl_invoice_schedule_update or ghl_invoice_schedule_activate; the agent must infer from the endpoint that this is the auto-payment-specific write. The auth note ('Requires an Agency or Sub-Account token') is a prerequisite, not a usage rule.

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