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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_cancel

Cancel a scheduled or recurring invoice by schedule ID to stop all remaining unsent occurrences; already-sent invoices remain unaffected.

Instructions

Stops all remaining not-yet-sent occurrences of this recurring/scheduled invoice. Already-sent invoices are unaffected. Cancel an scheduled invoice API to cancel a scheduled invoice by schedule id Endpoint: POST /invoices/schedule/{scheduleId}/cancel (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_cancel"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"CancelInvoiceScheduleDto"
  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 readOnly=false, idempotent=false, destructive=false, so safety basics are covered; the description adds the meaningful non-obvious behavior (only future occurrences are stopped, sent invoices untouched) plus auth requirements (Agency or Sub-Account token) and the invoices/schedule.write scope. It doesn't say what a second cancel attempt returns, which matters given idempotentHint=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 behavioral sentence is front-loaded and earns its place, but 'Cancel an scheduled invoice' and 'API to cancel a scheduled invoice by schedule id' restate the name and title twice, and the source/version metadata adds bulk for the agent.

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 mutating call with a nested body and no output schema, the description covers effect scope, side-effect boundary, auth, and scope. Missing only the failure/response behavior, which is a modest gap given the annotations already flag non-idempotency.

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 coverage is 100% and both parameters carry their own descriptions, including altId/altType semantics in the nested body. The endpoint line reveals that scheduleId goes in the path, a small addition, but nothing else is said about the body fields or altType constraints.

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?

Opens with a specific verb (stops) and a precisely scoped resource (all remaining not-yet-sent occurrences of this recurring/scheduled invoice), and explicitly excludes already-sent invoices. An agent can distinguish it from ghl_invoice_schedule_delete or ghl_invoice_schedule_update without reading the schema.

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 scope statement ('not-yet-sent occurrences', 'already-sent invoices are unaffected') gives clear context for when this is the right call. It stops short of naming the alternative sibling (schedule_delete, schedule_activate) or saying when not to use it, so nothing routes the agent between cancel and delete.

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