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

ghl-mcp-server-v2

by zackscriven

ghl_email_legacy_campaign_list

Read-onlyIdempotent

Lists legacy email campaigns and schedules for a location using limit/offset pagination with status and emailStatus filters, providing a fallback when current campaign endpoints are unavailable.

Instructions

Legacy schedule/campaign listing (2021-era, distinct from the v3 campaign family at /emails/locations/{locationId}/campaigns/emails). Supports limit/offset pagination plus status and emailStatus filters. [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Campaigns Endpoint: GET /emails/schedule (Version header: 2021-07-28; source: emails.json) Requires a Sub-Account (location) token. OAuth scopes: emails/schedule.readonly Pagination params: limit, offset — 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_email_legacy_campaign_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoFilter campaigns by name
limitNoMaximum number of campaigns to return. Defaults to 10, maximum is 100
offsetNoNumber of campaigns to skip for pagination
statusNoFilter by schedule statusactive
archivedNoFilter archived campaigns
parentIdNoFilter campaigns by parent folder ID
showStatsNoWhen true, returns campaign statistics including delivered count, opened count, clicked count and revenue if available for the campaign. When false, returns campaign data without statistics.
locationIdYesLocation ID to fetch campaigns from
emailStatusNoFilter by email delivery statuscomplete
campaignsOnlyNoReturn only campaigns, excluding folders
limitedFieldsNoWhen true, returns only essential campaign fields like id, templateDataDownloadUrl, updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false, returns complete campaign data including meta information, bulkRequestStatusInfo, ABTestInfo, resendScheduleInfo and all other campaign properties

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, and the description adds genuinely new behavioral facts: continued availability only under the legacy Version header, expected removal, the required Sub-Account token, and the emails/schedule.readonly OAuth scope. Pagination behavior (limit/offset paging through full result sets) is also disclosed.

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 distinguishing scope and the deprecation warning are front-loaded, which is correct. However, pagination is mentioned twice — once in the opening sentence and again in the trailing 'Pagination params: limit, offset' line — which is redundant against a schema that already documents both.

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 an 11-parameter read tool with no output schema, the description covers the essentials an agent needs: deprecation risk, auth requirements, and paging. It does not characterize the response payload, though the schema's showStats/limitedFields params go a long way toward conveying what comes back.

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 including the status/emailStatus enums is already documented. The description only restates that limit/offset and the status/emailStatus filters exist, adding no format or interaction detail beyond the schema; baseline 3 applies.

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?

States a specific verb and resource ('Legacy schedule/campaign listing') and explicitly distinguishes itself from the v3 campaign family at /emails/locations/{locationId}/campaigns/emails. The endpoint path and version header pin down exactly which API surface is being called.

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

Usage Guidelines4/5

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

Gives clear context for when to reach for this tool and warns that it is a legacy fallback with 'prefer a current equivalent.' It stops short of naming the concrete sibling (e.g. ghl_email_list_campaigns) that should be used instead, so the agent must infer the replacement.

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