Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

invoices_list_invoice_schedules

Read-onlyIdempotent

List invoice schedules with filters for status, payment mode, date range, and search. Retrieve paginated schedules using limit and offset parameters.

Instructions

List schedules

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
altIdNolocation Id / company Id based on altType Defaults to GHL_LOCATION_ID when omitted.
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
altTypeNoAlt Type Defaults to GHL_LOCATION_ID when omitted.
startAtNostartAt in YYYY-MM-DD format
paymentModeNopayment mode
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds no behavioral detail—no mention of pagination, filtering behavior, or return structure. With annotations present, the bar is lower, but the description still contributes nothing beyond the annotation-derived information.

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

Conciseness2/5

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

At two words, this is under-specification rather than effective conciseness. It lacks any structure or organization. While it's brief, it omits essential information, making it more of a stub than a concise description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 9 parameters, no output schema, and a vague two-word description, this is severely inadequate. The agent has no idea what schedules are, what filters exist, how pagination works, or what the response will look like. Even with annotations covering safety, the description fails to provide the operational context needed to call the tool correctly.

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 all 9 parameters already have descriptions in the schema. The description itself adds no parameter context, but the baseline of 3 applies because the schema carries the semantic weight. No extra meaning is provided by the description.

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?

The description 'List schedules' provides a verb and resource, and the tool name clarifies it's about invoice schedules. However, it doesn't distinguish itself from siblings like invoices_list_invoice_templates or invoices_list_estimates, and it gives no sense of scope or filtering. It's minimally clear but lacks specificity.

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

Usage Guidelines1/5

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

There is no guidance on when to use this tool versus alternatives. The sibling list includes many invoice-related tools, but the description offers no context about when listing schedules is appropriate, nor any exclusions or prerequisites. An agent would have to guess.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AIWerk/mcp-server-ghl'

If you have feedback or need assistance with the MCP directory API, please join our Discord server