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

ghl-mcp-server-v2

by zackscriven

ghl_email_get_campaign_stats

Read-onlyIdempotent

Retrieve statistics for email campaigns, workflow campaigns, or bulk actions by location and source ID to analyze performance and track results.

Instructions

Get Campaign Statistics Get statistics for email campaigns, workflows, or bulk actions Endpoint: GET /emails/locations/{locationId}/campaigns/stats/{source}/{sourceId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/stats.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>",
      "source": "<source>",
      "sourceId": "<sourceId>"
    },
    "name": "ghl_email_get_campaign_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceYesSource type: email-campaigns, workflow-campaigns, or bulk-actions
sourceIdYesSource ID of the email campaign, workflow campaign, or bulk action
locationIdYesLocation ID
subSourceIdNoWorkflow action ID. Only valid when source is `workflow-campaigns`

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 readOnly/idempotent/non-destructive, so the description's value is the operational context it adds: sub-account (location) token requirement, the OAuth scope emails/stats.readonly, and the API version header. That is genuinely useful pre-call information beyond 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?

Front-loaded purpose line followed by endpoint, auth, and scope in compact form. No filler sentences; every line carries operational information.

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?

No output schema exists, but for a read-only stats endpoint the description covers purpose, endpoint shape, required token type, and scope, which is enough for correct invocation. Return shape and metric details are unspecified, but that is a minor gap given annotations carry the safety profile.

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 all four parameters including the enum and the subSourceId conditional note are already documented. The description only restates the URL path parameters and never mentions subSourceId's workflow-only constraint, so it adds little beyond the schema.

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 ('Get statistics for email campaigns, workflows, or bulk actions') and the endpoint, so an agent knows exactly what it retrieves. It doesn't explicitly distinguish itself from near-siblings like ghl_email_get_campaign or ghl_email_get_bulk_action_campaign, which keeps it from 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?

The enum values imply the three usage cases (campaign vs workflow vs bulk action), but the description never says when to prefer this over ghl_email_get_campaign or ghl_email_get_bulk_action_campaign, nor any exclusions. Auth prerequisites are stated, which is a partial substitute for real usage guidance.

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