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

ghl-mcp-server-v2

by zackscriven

ghl_affiliate_commission_list

Read-onlyIdempotent

Retrieve and filter affiliate commissions for a specific location by status, date range, affiliate, or campaign, using skip/limit pagination to page through results.

Instructions

List Commissions Retrieve the list of commissions for a location. Endpoint: GET /affiliate-manager/{locationId}/commissions (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_commission_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNoNumber of records to skip for pagination
limitNoMaximum number of records to return. Maximum allowed value is 100.
queryNoQuery
statusNoStatus
toDateNoFilter commissions created on or before this date (YYYY-MM-DD)
fromDateNoFilter commissions created on or after this date (YYYY-MM-DD)
campaignIdNoCampaign Id
locationIdYesLocation Id
affiliateIdNoAffiliate Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.1.0
    • addedInput schema / properties / fromDate / description
      Added value: +"Filter commissions created on or after this date (YYYY-MM-DD)"
    • addedInput schema / properties / skip / description
      Added value: +"Number of records to skip for pagination"
    • 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: +"CommissionStatus"
    • addedInput schema / properties / toDate / description
      Added value: +"Filter commissions created on or before this date (YYYY-MM-DD)"
  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 declare readOnly, idempotent, non-destructive behavior. The description adds the endpoint, OAuth scope ('affiliate-manager.readonly'), and pagination handling, which are useful context beyond annotations. It does not, however, discuss rate limits or response behavior.

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 description is short and front-loads the operation before endpoint, auth, and pagination details. Some lines such as the source path and version header are implementation metadata rather than agent-facing guidance, but the total length remains 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?

For a read-only list tool with rich annotations and full schema coverage, the description covers invocation essentials: endpoint, auth scope, and pagination. It omits any description of the returned commission records, which is a gap because there is no output schema.

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 nine parameters are already documented. The description adds value only for skip/limit by saying to pass them to page through full result sets; it does not explain the filter parameters such as query, status, dates, campaignId, or affiliateId, relying on the schema instead.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Retrieve the list') and resource ('commissions'), scoped to a location. The 'list' verb separates it from sibling commission mutations such as create, update, deny, and delete, so an agent can identify the correct operation.

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?

It gives no explicit when-to-use guidance, prerequisites, or alternative tools; it only states that it retrieves commissions for a location and notes pagination. The agent must infer the usage context from the verb and resource.

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