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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_update

Idempotent

Update an existing invoice schedule by schedule ID, including recurrence, contact, items, and billing details.

Instructions

Update schedule API to update an schedule by schedule id Endpoint: PUT /invoices/schedule/{scheduleId} (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_update"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / attachments / items / title
      Added value: +"AttachmentsDto"
    • changedInput schema / properties / body / properties / businessDetails / properties / address / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "addressLine1": {
      -        "description": "Address Line 1",
      -        "example": "9931 Beechwood",
      -        "type": "string"
      -      },
      -      "addressLine2": {
      -        "description": "Address Line 2",
      -        "example": "Beechwood",
      -        "type": "string"
      -      },
      -      "city": {
      -        "description": "City",
      -        "example": "St. Houston",
      -        "type": "string"
      -      },
      -      "countryCode": {
      -        "description": "Country Code",
      -        "example": "US",
      -        "type": "string"
      -      },
      -      "postalCode": {
      -        "description": "Postal Code",
      -        "example": "559-6993",
      -        "type": "string"
      -      },
      -      "state": {
      -        "description": "State",
      -        "example": "TX",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "addressLine1": {
      +        "description": "Address Line 1",
      +        "example": "9931 Beechwood",
      +        "type": "string"
      +      },
      +      "addressLine2": {
      +        "description": "Address Line 2",
      +        "example": "Beechwood",
      +        "type": "string"
      +      },
      +      "city": {
      +        "description": "City",
      +        "example": "St. Houston",
      +        "type": "string"
      +      },
      +      "countryCode": {
      +        "description": "Country Code",
      +        "example": "US",
      +        "type": "string"
      +      },
      +      "postalCode": {
      +        "description": "Postal Code",
      +        "example": "559-6993",
      +        "type": "string"
      +      },
      +      "state": {
      +        "description": "State",
      +        "example": "TX",
      +        "type": "string"
      +      }
      +    },
      +    "title": "AddressDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / businessDetails / title
      Added value: +"BusinessDetailsDto"
    • addedInput schema / properties / body / properties / contactDetails / properties / additionalEmails / items / title
      Added value: +"AdditionalEmailsDto"
    • addedInput schema / properties / body / properties / contactDetails / properties / address / title
      Added value: +"AddressDto"
    • addedInput schema / properties / body / properties / contactDetails / title
      Added value: +"ContactDetailsDto"
    • addedInput schema / properties / body / properties / discount / title
      Added value: +"DiscountDto"
    • addedInput schema / properties / body / properties / items / items / properties / taxes / items / title
      Added value: +"ItemTaxDto"
    • addedInput schema / properties / body / properties / items / items / title
      Added value: +"InvoiceItemDto"
    • changedInput schema / properties / body / properties / miscellaneousCharges / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "charges": {
      -        "description": "charges for the processing fee",
      -        "items": {
      -          "type": "array"
      -        },
      -        "type": "array"
      -      },
      -      "collectedMiscellaneousCharges": {
      -        "description": "collected miscellaneous charges",
      -        "example": 10,
      -        "type": "number"
      -      },
      -      "paidCharges": {
      -        "description": "paid miscellaneous charges",
      -        "items": {
      -          "properties": {
      -            "_id": {
      -              "description": "id of the processing fee",
      -              "example": "673d01d7d547648a8dab6211",
      -              "type": "string"
      -            },
      -            "amount": {
      -              "description": "amount of the processing fee",
      -              "example": 10,
      -              "type": "number"
      -            },
      -            "charge": {
      -              "description": "charge for the processing fee",
      -              "example": 10,
      -              "type": "number"
      -            },
      -            "name": {
      -              "description": "name of the processing fee",
      -              "example": "Processing Fee",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "name",
      -            "charge",
      -            "amount",
      -            "_id"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "charges"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "charges": {
      +        "description": "charges for the processing fee",
      +        "items": {
      +          "type": "array"
      +        },
      +        "type": "array"
      +      },
      +      "collectedMiscellaneousCharges": {
      +        "description": "collected miscellaneous charges",
      +        "example": 10,
      +        "type": "number"
      +      },
      +      "paidCharges": {
      +        "description": "paid miscellaneous charges",
      +        "items": {
      +          "properties": {
      +            "_id": {
      +              "description": "id of the processing fee",
      +              "example": "673d01d7d547648a8dab6211",
      +              "type": "string"
      +            },
      +            "amount": {
      +              "description": "amount of the processing fee",
      +              "example": 10,
      +              "type": "number"
      +            },
      +            "charge": {
      +              "description": "charge for the processing fee",
      +              "example": 10,
      +              "type": "number"
      +            },
      +            "name": {
      +              "description": "name of the processing fee",
      +              "example": "Processing Fee",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "charge",
      +            "amount",
      +            "_id"
      +          ],
      +          "title": "ProcessingFeePaidChargeDto",
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "charges"
      +    ],
      +    "title": "ProcessingFeeDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / schedule / properties / rrule / title
      Added value: +"CustomRRuleOptionsDto"
    • addedInput schema / properties / body / properties / schedule / title
      Added value: +"ScheduleOptionsDto"
    • addedInput schema / properties / body / title
      Added value: +"UpdateInvoiceScheduleDto"
  2. First observedv2.0.0

TDQS

B3.1/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false, openWorldHint=true), and the description adds genuinely useful context beyond them: the PUT endpoint, the v3 version header, the requirement for an Agency or Sub-Account token, and the invoices/schedule.write OAuth scope. It stops short of noting that the body is a full replacement requiring all required fields, which would have made it a 5.

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

Conciseness4/5

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

Five short lines, front-loaded with the operation and followed by endpoint, auth, and scope metadata. Slightly awkward phrasing ("an schedule") and the header metadata is dense, but there is no filler.

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?

For a mutation on a complex nested DTO, the description covers transport, auth, and scope, and annotations cover safety and idempotency. What is missing is the operational distinction from update_and_activate and any notion of update semantics (full replace vs partial), which matters for a tool with a 10-field required body.

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 the scheduleId and the large nested body object are already documented in the schema. The description adds nothing about body semantics (e.g. that unmentioned fields may be cleared, or how rrule interacts with executeAt), so the baseline 3 applies.

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

Purpose3/5

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

"Update schedule" plus "update an schedule by schedule id" states a verb and resource, so the basic operation is identifiable. However, it never differentiates from the closely related siblings ghl_invoice_schedule_update_and_activate, ghl_invoice_schedule_activate, or ghl_invoice_schedule_cancel, which is the main ambiguity an agent would face here.

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

Usage Guidelines2/5

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

The description gives no when-to-use or when-not-to-use guidance. It does not say whether this should be preferred over update_and_activate when the schedule should also go live, nor does it mention prerequisites such as the schedule needing to be in a non-active state.

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