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

ghl-mcp-server-v2

by zackscriven

ghl_affiliate_get

Read-onlyIdempotent

Retrieves a single affiliate by ID for a specific location so you can inspect its details in GoHighLevel.

Instructions

Get Affiliate Retrieve a single affiliate by id for a location. Endpoint: GET /affiliate-manager/{locationId}/affiliates/{affiliateId} (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.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": {
      "locationId": "<locationId>",
      "affiliateId": "<affiliateId>"
    },
    "name": "ghl_affiliate_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
locationIdYesLocation Id
affiliateIdYesAffiliate Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • changedInput schema / properties / affiliateId / example
      Previous value: -"ve9EPM428h8vShlRW1KT"New value: +"6385d230f6d19db03eef6fb2"
  2. First observedv2.0.0

TDQS

A3.8/5.0
Behavior4/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 safety is covered; the description goes beyond them by naming the required OAuth scope (affiliate-manager.readonly), the HTTP method/path, and the API version header. That permission and versioning context is real value an agent cannot get from the annotations.

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

Conciseness5/5

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

The operational sentence is front-loaded and the metadata (version header, source file) is compact trailing detail. Nothing is redundant, though the source-file reference 'v3/affiliate-manager-v3.json' is close to tooling noise.

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?

With no output schema, the description does not need to explain return values, and annotations carry the safety profile; the addition of auth scope and endpoint makes it callable as-is. It lacks only guidance on what happens if the affiliate is not found or whether the response includes nested payout data.

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?

Both parameters are fully described in the schema (100% coverage), so the baseline is 3. The endpoint template does show that locationId is the path scope and affiliateId identifies the record, but no formats, constraints, or error behaviors are added.

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 ('Retrieve') and resource ('a single affiliate') scoped to a location, which distinguishes it functionally from ghl_affiliate_list. It stops short of naming the sibling it competes with, so the differentiation must be inferred from 'single' plus the required affiliateId.

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 phrase 'by id for a location' plus two required identifiers implies when this is the right call (you already know the affiliate id). There is no explicit when-to-use, no mention of a list/search alternative when the id is unknown, and no stated prerequisites beyond the OAuth scope.

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