Skip to main content
Glama

Leadconnector

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Leadconnector List Campaigns

leadconnector_list_campaigns
Read-onlyIdempotent

List marketing/automation campaigns in the account. Returns a {campaigns:[...]} envelope with campaign IDs, names, and status. Useful for finding a campaign to attribute or enroll contacts. Requires your own GoHighLevel token via _apiKey (plus locationId for a v2 pit- token).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
_apiKeyYesYour own GoHighLevel/LeadConnector token (BYO — Pipeworx does not supply one). Either a v2 Private Integration Token (`pit-` prefixed; Settings → Private Integrations) — pass `locationId` with it — or a legacy v1 Location API key (Settings → Business Profile → API Key). GoHighLevel has retired v1 key creation, so new accounts will have a v2 token.
locationIdNoGoHighLevel sub-account (Location) ID. REQUIRED with a v2 `pit-` token, ignored for a v1 key. It is the id in the dashboard URL: …/location/<locationId>/…

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / examples
      Previous value: -[
-  {
-    "_apiKey": "your-leadconnector-api-key"
-  }
-]New value: +[
+  {
+    "_apiKey": "pit-your-private-integration-token",
+    "locationId": "ve9EPM428h8vShlRW1KT"
+  }
+]
  2. Changed2 schema fields changed
    • changedInput schema / properties / _apiKey / description
      Previous value: -"GoHighLevel/LeadConnector v1 Location API key (Settings → Business Profile → API Key). NOT a v2 Private Integration Token (`pit-` prefixed)."New value: +"Your own GoHighLevel/LeadConnector token (BYO — Pipeworx does not supply one). Either a v2 Private Integration Token (`pit-` prefixed; Settings → Private Integrations) — pass `locationId` with it — or a legacy v1 Location API key (Settings → Business Profile → API Key). GoHighLevel has retired v1 key creation, so new accounts will have a v2 token."
    • addedInput schema / properties / locationId
      Added value: +{
+  "description": "GoHighLevel sub-account (Location) ID. REQUIRED with a v2 `pit-` token, ignored for a v1 key. It is the id in the dashboard URL: …/location/<locationId>/…",
+  "type": "string"
+}
  3. Changed1 schema field changed
    • changedInput schema / properties / _apiKey / description
      Previous value: -"GoHighLevel/LeadConnector Location API key"New value: +"GoHighLevel/LeadConnector v1 Location API key (Settings → Business Profile → API Key). NOT a v2 Private Integration Token (`pit-` prefixed)."
  4. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "_apiKey": "your-leadconnector-api-key"
+  }
+]
  5. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Adds context beyond the readOnly/idempotent annotations: the returned envelope shape, the BYO-token requirement, and the v2 token needing locationId. No contradiction with annotations, and the auth behavior is useful for correct invocation.

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?

Three sentences with no filler: purpose, return shape, use case, and auth requirement are all covered. The most decision-relevant information is front-loaded.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter read-only list tool, the description is complete: it explains the return envelope, the reason to use it, and the authentication nuances. The absence of an output schema is compensated by the explicit return description.

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 the baseline is 3. The description's token/locationId mention mostly repeats the schema, adding no meaningful parameter semantics beyond what is already documented.

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: 'List marketing/automation campaigns in the account.' It also clarifies the return shape (envelope with IDs, names, status), which clearly distinguishes it from sibling tools like leadconnector_list_contacts, leadconnector_list_opportunities, and leadconnector_list_pipelines.

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?

Provides a clear use case: 'Useful for finding a campaign to attribute or enroll contacts.' It does not explicitly name alternatives or exclusion conditions, but the campaign-specific purpose is enough to guide selection among the sibling list tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Leadconnector toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources