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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_list

Read-onlyIdempotent

Retrieve invoice schedules for a location, with pagination and filters for status, date range, search, and payment mode. Use limit and offset to page through results.

Instructions

List schedules API to get list of schedules Endpoint: GET /invoices/schedule (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.readonly Pagination params: limit, offset — pass them to page through full result sets.

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": {
      "altId": "<altId>",
      "altType": "<altType>",
      "limit": "<limit>",
      "offset": "<offset>"
    },
    "name": "ghl_invoice_schedule_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYeslocation Id / company Id based on altType
endAtNoendAt in YYYY-MM-DD format
limitYesLimit the number of items to return
offsetYesNumber of items to skip
searchNoTo search for an invoice by id / name / email / phoneNo
statusNostatus to be filtered
altTypeYesAlt Type
startAtNostartAt in YYYY-MM-DD format
paymentModeNopayment mode

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already declare the tool as read-only, idempotent, open-world, and non-destructive. The description adds useful context beyond annotations: it requires an Agency or Sub-Account token, names the OAuth scope invoices/schedule.readonly, and explains that limit/offset are for paging through full result sets.

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 purpose is front-loaded, but “List schedules” and “API to get list of schedules” are redundant. The endpoint, auth, and pagination details earn their place, but the repeated opening reduces crispness.

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 nine-parameter list tool with no output schema, the description covers auth, OAuth scope, and pagination but omits filtering behavior and return shape. The schema carries the parameter details, so this is adequate but not fully complete.

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 the schema already documents all nine parameters. The description adds only that limit and offset are pagination parameters, without clarifying the filtering semantics of search, status, date range, or paymentMode beyond what the schema provides.

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 states a specific verb and resource: list invoice schedules via GET /invoices/schedule. It is clear what the tool does, but it does not distinguish this list operation from sibling tools such as ghl_invoice_schedule_get or ghl_invoice_list.

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 provides auth requirements and pagination guidance, but it gives no explicit when-to-use or when-not-to-use guidance versus alternatives. An agent must infer that this is the listing operation from the name and endpoint.

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