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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_delete

DestructiveIdempotent

Deletes an invoice schedule by schedule ID, using altId and altType for location context to remove unwanted scheduled invoice actions.

Instructions

Delete schedule API to delete an schedule by schedule id Endpoint: DELETE /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>",
      "altId": "<altId>",
      "altType": "<altType>"
    },
    "name": "ghl_invoice_schedule_delete"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYeslocation Id / company Id based on altType
altTypeYesAlt Type
scheduleIdYesSchedule Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is covered. The description adds genuinely new context, the required Agency/Sub-Account token and the invoices/schedule.write OAuth scope, but says nothing about consequences: whether the schedule's linked invoice survives, whether scheduled payments are dropped, or whether the action is reversible.

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?

The purpose is front-loaded in the first two lines and the remaining lines are short, scannable facts (endpoint, auth, scope). Minor waste in the 'API to delete an schedule by schedule id' restatement and a grammatical slip, but nothing bloated.

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 destructive, idempotent mutation with annotations, a complete param schema and no output schema, the definition covers auth and scoping but omits the main behavioral question an agent needs answered before calling: what is destroyed and whether related invoices/payments are affected.

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 scheduleId, altId and altType are already documented in the schema. The description restates only scheduleId and adds no semantics for the location/company scoping parameters (altId/altType), which is the baseline 3 case.

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 (delete an invoice schedule by scheduleId) and names the exact endpoint, so the operation is unambiguous. It stops short of 5 because the sibling set contains ghl_invoice_schedule_cancel, and the description never distinguishes deleting a schedule from cancelling one.

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?

There is no guidance on when to delete versus cancel/update/activate a schedule, nor any note about prerequisites or recovery. The closest thing to guidance is the auth requirement, which is a constraint rather than a selection 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