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

ghl-mcp-server-v2

by zackscriven

ghl_email_get_campaign

Read-onlyIdempotent

Retrieves a single email campaign by location ID and campaign ID so you can review campaign details and manage email activity.

Instructions

Get Email Campaign by ID Get a single email campaign by its ID Endpoint: GET /emails/locations/{locationId}/campaigns/emails/{campaignId} (Version header: v3; source: v3/emails-v3.json) Requires a Sub-Account (location) token. OAuth scopes: emails/campaigns.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>",
      "campaignId": "<campaignId>"
    },
    "name": "ghl_email_get_campaign"
  }
}

Input Schema

NameRequiredDescriptionDefault
campaignIdYesCampaign ID
locationIdYesLocation ID

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 readOnlyHint, idempotentHint and openWorldHint, so the safety profile is covered. The description adds genuine context the annotations cannot: it requires a Sub-Account (location) token and an emails/campaigns.readonly OAuth scope, and notes the v3 version header, which matters for auth failures.

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 purpose statement is front-loaded in the first line, with auth and endpoint metadata following. Slightly verbose for a two-parameter GET (the source-file reference is marginal), but every other line carries operational value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 should say what a campaign object contains or at least that it returns the full campaign record; it does not. Auth, scope and endpoint are covered, so an agent can call it correctly but cannot anticipate the response.

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% and both parameters carry descriptions and examples, so the schema does the heavy lifting. The description adds no format or semantics beyond what the schema provides (e.g. no guidance on where to obtain locationId or campaignId), so the 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 ('Get') and resource ('a single email campaign by its ID') and even gives the exact REST endpoint. The word 'single' plus the mandatory campaignId implicitly separates it from the sibling ghl_email_list_campaigns.

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 ID-based single-record shape implies when to use it versus a list call, and the token/scope requirements hint at prerequisites, but there is no explicit when-to-use, when-not-to-use, or named alternative such as ghl_email_list_campaigns or ghl_email_get_campaign_stats.

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