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

ghl-mcp-server-v2

by zackscriven

ghl_affiliate_list

Read-onlyIdempotent

Retrieve and filter affiliates for a location by name, email, active status, date range, or campaign, with pagination to page through full result sets.

Instructions

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

Input Schema

NameRequiredDescriptionDefault
skipNoNumber of records to skip for pagination
limitNoMaximum number of records to return. Maximum allowed value is 100. A value of 0 is treated as the default of 10.
queryNoSearch affiliates by name or email
activeNoFilter affiliates by active status
toDateNoFilter affiliates created on or before this date (YYYY-MM-DD)
fromDateNoFilter affiliates created on or after this date (YYYY-MM-DD)
campaignIdNoFilter affiliates by campaign ID
locationIdYesLocation Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.1.0
    • addedInput schema / properties / active / description
      Added value: +"Filter affiliates by active status"
    • addedInput schema / properties / campaignId / description
      Added value: +"Filter affiliates by campaign ID"
    • addedInput schema / properties / fromDate / description
      Added value: +"Filter affiliates created on or after this date (YYYY-MM-DD)"
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of records to return. Maximum allowed value is 100."New value: +"Maximum number of records to return. Maximum allowed value is 100. A value of 0 is treated as the default of 10."
    • addedInput schema / properties / limit / maximum
      Added value: +100
    • addedInput schema / properties / limit / minimum
      Added value: +0
    • addedInput schema / properties / query / description
      Added value: +"Search affiliates by name or email"
    • addedInput schema / properties / skip / description
      Added value: +"Number of records to skip for pagination"
    • addedInput schema / properties / skip / minimum
      Added value: +0
    • addedInput schema / properties / toDate / description
      Added value: +"Filter affiliates 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 establish readOnly, idempotent, non-destructive and open-world. The description adds value beyond that with the exact endpoint, the v3 API version header, the required OAuth scope, and the pagination caveat that results must be paged to be complete. That is meaningful operational context, though return shape is unaddressed.

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, and pagination note in four compact lines with no filler. The 'source: v3/affiliate-manager-v3.json' provenance detail is slightly internal but costs little.

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 a fully documented 8-parameter schema and no output schema, the description plus annotations cover what an agent needs to invoke it: endpoint, scope, and pagination strategy. Only the absence of any hint about response shape or result ordering keeps it from a 5.

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 all eight parameters including skip/limit/query/active/date filters are documented in the schema itself. The description only reiterates pagination via skip and limit, adding no syntax or semantics beyond what the schema already provides. Baseline 3 applies.

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 and resource: 'Retrieve the list of affiliates for a location', reinforced by the exact endpoint GET /affiliate-manager/{locationId}/affiliates. It does not explicitly distinguish itself from near-siblings like ghl_affiliate_get or ghl_affiliate_list_campaigns, but the scoping to a location's affiliate roster is clear enough.

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?

The description supplies the OAuth scope ('affiliate-manager.readonly') and instructs the agent to pass skip/limit to page through full result sets, which is implied usage guidance. However, it never says when to prefer this tool over ghl_affiliate_get or the other affiliate list endpoints, and gives 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