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

ghl-mcp-server-v2

by zackscriven

ghl_invoice_schedule_get

Read-onlyIdempotent

Retrieves an invoice schedule by schedule ID for a specified location or company, returning the schedule details through the GoHighLevel API.

Instructions

Get an schedule API to get an schedule by schedule id Endpoint: GET /invoices/schedule/{scheduleId} (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.readonly

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_get"
  }
}

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

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint; the description adds real context beyond them — the Agency or Sub-Account token requirement and the OAuth scope invoices/schedule.readonly, which an agent needs before calling. It does not cover rate limits or error behavior, but for a read tool this is solid.

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?

Front-loaded with the operation, followed by endpoint, auth and scopes in a scannable order. Slightly redundant ('Get an schedule' then 'API to get an schedule') and the source-file parenthetical is noise, but size is appropriate.

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?

A simple single-resource GET with no output schema: the description supplies endpoint, API version header, auth requirements and OAuth scope, which is most of what the agent needs. Missing only a hint about the shape of the returned schedule.

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 only echoes scheduleId via the endpoint path template and adds nothing about altId/altType (e.g. that altType is always 'location'), so it stays at baseline.

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 (retrieve a single invoice schedule by schedule ID) and the endpoint makes the scope unambiguous, distinguishing it from siblings such as ghl_invoice_schedule_list or ghl_invoice_schedule_update. The phrasing 'Get an schedule' is grammatically sloppy and restates the name, but the ID-based retrieval is clear.

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?

Implicitly this is the lookup-by-ID tool as opposed to the list tool, but the description never says when to use it versus ghl_invoice_schedule_list or the other schedule siblings. No exclusions or prerequisites beyond the token requirement are given.

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