@pipeworx/mcp-leadconnector 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pipeworx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# mcp-leadconnector
+
+LeadConnector / GoHighLevel MCP Pack — wraps the GoHighLevel CRM for AI agents.
+
+Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 250+ live data sources.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+
+## Quick Start
+
+Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
+
+```json
+{
+  "mcpServers": {
+    "leadconnector": {
+      "url": "https://gateway.pipeworx.io/leadconnector/mcp"
+    }
+  }
+}
+```
+
+Or connect to the full Pipeworx gateway for access to all 250+ data sources:
+
+```json
+{
+  "mcpServers": {
+    "pipeworx": {
+      "url": "https://gateway.pipeworx.io/mcp"
+    }
+  }
+}
+```
+
+## Using with ask_pipeworx
+
+Instead of calling tools directly, you can ask questions in plain English:
+
+```
+ask_pipeworx({ question: "your question about Leadconnector data" })
+```
+
+The gateway picks the right tool and fills the arguments automatically.
+
+## More
+
+- [All tools and guides](https://github.com/pipeworx-io/examples)
+- [pipeworx.io](https://pipeworx.io)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pipeworx/mcp-leadconnector",
+  "version": "0.1.0",
+  "description": "LeadConnector / GoHighLevel MCP Pack — wraps the GoHighLevel CRM for AI agents.",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "leadconnector"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pipeworx-io/mcp-leadconnector"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}

package/server.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+  "name": "io.github.pipeworx-io/leadconnector",
+  "title": "Leadconnector",
+  "description": "LeadConnector / GoHighLevel MCP Pack — wraps the GoHighLevel CRM for AI agents.",
+  "version": "0.1.0",
+  "websiteUrl": "https://pipeworx.io/packs/leadconnector",
+  "repository": {
+    "url": "https://github.com/pipeworx-io/mcp-leadconnector",
+    "source": "github"
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://gateway.pipeworx.io/leadconnector/mcp"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,163 @@
+interface McpToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+  };
+}
+
+interface McpToolExport {
+  tools: McpToolDefinition[];
+  callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
+  meter?: { credits: number };
+  cost?: Record<string, unknown>;
+  provider?: string;
+}
+
+/**
+ * LeadConnector / GoHighLevel MCP Pack — wraps the GoHighLevel CRM for AI agents.
+ *
+ * BYO key: pass _apiKey on every call. This is a GoHighLevel/LeadConnector
+ * **Location API key** (in the dashboard: Settings → Business Profile → API Key).
+ * It is a single static bearer token scoped to one Location (sub-account).
+ *
+ * API: GoHighLevel v1 REST API — base https://rest.gohighlevel.com/v1
+ * Auth: `Authorization: Bearer ${apiKey}`.
+ * Quirks:
+ *   - Collection responses are wrapped, e.g. {contacts:[...], meta:{...}},
+ *     {pipelines:[...]}, {campaigns:[...]}.
+ *   - Opportunities are nested under a pipeline: /pipelines/{pipelineId}/opportunities/
+ *     (there is no top-level /opportunities/ in v1 — it 404s), so list_opportunities
+ *     requires a pipelineId (fetch one first via list_pipelines).
+ *   - A missing/invalid key returns HTTP 401 {"msg":"Api key is invalid."}.
+ *   - v1 /users/ is deprecated for Location keys (401 "Switch to the new API token"),
+ *     so no users tool is exposed.
+ */
+
+
+const API = 'https://rest.gohighlevel.com/v1';
+
+function headers(apiKey: string): Record<string, string> {
+  return {
+    Authorization: `Bearer ${apiKey}`,
+    Accept: 'application/json',
+    'User-Agent': 'pipeworx-mcp-leadconnector/1.0 (+https://pipeworx.io)',
+  };
+}
+
+async function lcGet(apiKey: string, path: string, params?: URLSearchParams): Promise<unknown> {
+  const qs = params?.toString();
+  const url = `${API}${path}${qs ? `?${qs}` : ''}`;
+  const res = await fetch(url, { headers: headers(apiKey) });
+  if (!res.ok) {
+    const body = await res.text();
+    throw new Error(`LeadConnector: ${res.status} ${body.slice(0, 200)}`);
+  }
+  return res.json();
+}
+
+// -- Tool definitions --------------------------------------------------------
+
+const tools: McpToolExport['tools'] = [
+  {
+    name: 'leadconnector_list_contacts',
+    description:
+      'Search or list CRM contacts in a GoHighLevel/LeadConnector account. Free-text query matches name, email, or phone. Returns a {contacts:[...], meta} envelope with contact IDs, names, emails, phones, tags, and custom fields.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GoHighLevel/LeadConnector Location API key (Settings → Business Profile → API Key)' },
+        query: { type: 'string', description: 'Free-text search across contact name, email, and phone' },
+        limit: { type: 'number', description: 'Max contacts to return (default 20, max 100)' },
+      },
+      required: ['_apiKey'],
+    },
+  },
+  {
+    name: 'leadconnector_get_contact',
+    description:
+      'Fetch a single CRM contact by its contact ID. Returns full detail: name, email, phone, tags, source, custom fields, and timestamps.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GoHighLevel/LeadConnector Location API key' },
+        contactId: { type: 'string', description: 'GoHighLevel contact ID' },
+      },
+      required: ['_apiKey', 'contactId'],
+    },
+  },
+  {
+    name: 'leadconnector_list_pipelines',
+    description:
+      'List all sales pipelines and their stages in the account. Returns a {pipelines:[...]} envelope with pipeline IDs, names, and ordered stages. Use the returned pipeline ID with leadconnector_list_opportunities.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GoHighLevel/LeadConnector Location API key' },
+      },
+      required: ['_apiKey'],
+    },
+  },
+  {
+    name: 'leadconnector_list_opportunities',
+    description:
+      'List opportunities (pipeline deals) for a given pipeline. Requires a pipelineId (get one from leadconnector_list_pipelines). Returns deals with monetary value, stage, status, and the associated contact.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GoHighLevel/LeadConnector Location API key' },
+        pipelineId: { type: 'string', description: 'Pipeline ID to list opportunities for (from leadconnector_list_pipelines)' },
+        limit: { type: 'number', description: 'Max opportunities to return (default 20, max 100)' },
+      },
+      required: ['_apiKey', 'pipelineId'],
+    },
+  },
+  {
+    name: 'leadconnector_list_campaigns',
+    description:
+      '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.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        _apiKey: { type: 'string', description: 'GoHighLevel/LeadConnector Location API key' },
+      },
+      required: ['_apiKey'],
+    },
+  },
+];
+
+// -- callTool dispatcher -----------------------------------------------------
+
+async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
+  const apiKey = args._apiKey as string | undefined;
+  delete args._context;
+  delete args._apiKey;
+
+  if (!apiKey) throw new Error('_apiKey is required for LeadConnector/GoHighLevel API access');
+
+  switch (name) {
+    case 'leadconnector_list_contacts': {
+      const params = new URLSearchParams();
+      if (args.query) params.set('query', String(args.query));
+      if (args.limit) params.set('limit', String(Math.min(100, Number(args.limit))));
+      return lcGet(apiKey, '/contacts/', params);
+    }
+    case 'leadconnector_get_contact':
+      return lcGet(apiKey, `/contacts/${encodeURIComponent(String(args.contactId))}`);
+    case 'leadconnector_list_pipelines':
+      return lcGet(apiKey, '/pipelines/');
+    case 'leadconnector_list_opportunities': {
+      const params = new URLSearchParams();
+      if (args.limit) params.set('limit', String(Math.min(100, Number(args.limit))));
+      return lcGet(apiKey, `/pipelines/${encodeURIComponent(String(args.pipelineId))}/opportunities/`, params);
+    }
+    case 'leadconnector_list_campaigns':
+      return lcGet(apiKey, '/campaigns/');
+    default:
+      throw new Error(`Unknown tool: ${name}`);
+  }
+}
+
+export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["src"]
+}