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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_activate

Activates a previously created recurring invoice schedule so it begins sending invoices to the customer. Use it to start a pending invoice schedule via scheduleId and billing details.

Instructions

Activates (starts sending) a previously created but not-yet-scheduled recurring invoice. Schedule an schedule invoice API to schedule an schedule invoice to start sending to the customer Endpoint: POST /invoices/schedule/{scheduleId}/schedule (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_activate"
  }
}

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: +"ScheduleInvoiceScheduleDto"
  2. 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 readOnly=false, destructive=false, idempotent=false, and openWorld=true, so the safety baseline is covered. The description adds meaningful context beyond that: it discloses that the operation begins sending to the customer, and documents the required token type (Agency or Sub-Account) and OAuth scope (invoices/schedule.write), which help the agent understand prerequisites.

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 effect is front-loaded in the first sentence, but the second and third sentences are repetitive and contain an obvious typo ('Schedule an schedule invoice'), duplicating the same idea three ways. Trimming those would sharpen the definition.

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 two-parameter mutation with a nested body and no output schema, the description supplies the endpoint, version header, auth token requirement, and OAuth scope, which is enough for an agent to invoke it correctly. It lacks any return-value hint, but no output schema exists and the mutation effect is stated.

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 both scheduleId and the nested body fields are already documented in the schema. The description adds nothing about the parameters beyond the endpoint path placeholder, so baseline 3 is appropriate.

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?

Opens with a specific verb and resource: 'Activates (starts sending) a previously created but not-yet-scheduled recurring invoice.' This clearly distinguishes it from siblings like ghl_invoice_schedule_create or ghl_invoice_schedule_update_and_activate by stating the invoice must already exist and the action is activation. However, the following duplicated sentences ('Schedule an schedule invoice', 'API to schedule an schedule invoice...') muddle the terminology, mixing 'activate' and 'schedule' verbs.

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?

The phrase 'previously created but not-yet-scheduled' implies the precondition to use this tool, and 'starts sending' clarifies the effect. But there is no explicit comparison to alternatives such as ghl_invoice_schedule_update_and_activate or ghl_invoice_schedule_create, which an agent would need to disambiguate which sibling to call.

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