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

ghl-mcp-server-v2

by zackscriven

ghl_affiliate_payout_list

Read-onlyIdempotent

Retrieve affiliate payouts for a location with date, status, campaign, and affiliate filters, plus pagination to page through results.

Instructions

List Payouts Retrieve the list of payouts for a location. Endpoint: GET /affiliate-manager/{locationId}/payouts (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — 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": {
      "locationId": "<locationId>"
    },
    "name": "ghl_affiliate_payout_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
endNoFilter payouts on or before this date (ISO 8601)
skipNoNumber of records to skip for pagination
limitNoMaximum number of records to return
queryNoquery
startNoFilter payouts on or after this date (ISO 8601)
statusNoPayout Status
campaignIdNoCampaign Id
locationIdYesLocation Id
affiliateIdNoAffiliate Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv2.1.0
    • addedInput schema / properties / end / description
      Added value: +"Filter payouts on or before this date (ISO 8601)"
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of records to return"
    • addedInput schema / properties / skip / description
      Added value: +"Number of records to skip for pagination"
    • addedInput schema / properties / start / description
      Added value: +"Filter payouts on or after this date (ISO 8601)"
    • changedInput schema / properties / status / description
      Previous value: -"Payout status"New value: +"Payout Status"
    • addedInput schema / properties / status / enum
      Added value: +[
      +  "pending",
      +  "approved",
      +  "paid",
      +  "denied"
      +]
    • removedInput schema / properties / status / example
      Removed value: -"pending"
    • addedInput schema / properties / status / title
      Added value: +"Payout Status"
  2. 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 establish readOnly/idempotent/non-destructive behavior, so the bar is lower; the description still adds real context: the OAuth scope required (affiliate-manager.readonly), the concrete endpoint/version, and that skip/limit should be used to page through full result sets. It doesn't mention rate limits or ordering, which keeps it at 4.

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 purpose, then endpoint/scope/pagination in compact lines with zero filler. The endpoint/source metadata is slightly implementation-heavy but is genuinely useful for a generated API wrapper.

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 read-only list tool with full schema description coverage and annotations covering safety, the description supplies the auth scope and pagination guidance an agent needs to call it correctly. Absent an output schema, it could say more about the returned payout shape, but that's a minor gap.

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%, so every parameter is already documented in the schema. The description's pagination note reinforces skip/limit usage but adds no new syntax or filter semantics beyond what the schema states. Baseline 3 is appropriate.

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?

Specific verb+resource: 'Retrieve the list of payouts for a location.' An agent can tell this apart from affiliate_commission_list or affiliate_list_payout_methods by the resource noun. It does not explicitly name a sibling to avoid, so it stops short of a 5.

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?

Usage is implied by the resource and the location scoping, and the pagination sentence signals it returns multi-record result sets. But there is no explicit statement of when to use this versus the commission or payout-method list endpoints, and no exclusions.

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