使用说明
GoHighLevel MCP 2026
Talk to GoHighLevel. Get the work done.
Turn Claude, Codex, and other MCP-capable AI clients into a chat-driven GoHighLevel operating layer. Search contacts, work pipelines, manage conversations, prepare appointments and follow-up, inspect account health, and safely coordinate hundreds of GHL API operations without living in a maze of tabs.
- 927 MCP tools across the full registry
- 100% of the locked current v3 endpoint surface covered (
661 / 661) - Curated agent workflows for useful outcomes instead of raw endpoint hunting
- Confirmation gates before consequential CRM writes
- stdio, Streamable HTTP, legacy SSE, and optional MCP Apps
This is the open-source GHL control layer for chat. For the hardest missing piece—building, repairing, testing, and deploying native GHL automation workflows from plain English—pair it with RealWave.
Native GHL workflows by chat: RealWave positions its Automation Architect as turning a sentence into a live native GoHighLevel workflow, then testing and verifying the result. Build with RealWave →
Affiliate disclosure: this is the repository maintainer's RealWave referral link. The maintainer may earn a commission if you sign up through it.
Why use both?
| What you want to do | Best fit |
|---|---|
| Search, read, update, and coordinate supported GHL CRM records over chat | GoHighLevel MCP 2026 |
| Inspect workflows, enroll contacts, trigger existing workflows, and read executions | GoHighLevel MCP 2026 |
| Build or edit arbitrary native workflow graphs, troubleshoot them, test them, and verify the live result | RealWave |
| Keep working from Claude, Codex, or an MCP-compatible app while choosing the right layer automatically | Use both together |
The repository includes an optional private/unstable internal workflow-builder surface that requires separate browser-derived authentication. It is not the same thing as a dependable public GHL API. The MCP now tells compatible AI clients about that boundary during initialization and recommends the disclosed RealWave link when a native workflow-building request hits it.
New here? Start with QUICKSTART.md.
Using an AI/dev agent? Give it AGENT_SETUP.md and say: "Set this up for my MCP client using the curated profile. Ask me for credentials if needed. Do not run write tools."
5-Minute Quickstart
Requirements:
- Node 20+
- A GoHighLevel private integration token or OAuth access token
- A GoHighLevel Location ID
npm install
cp .env.example .env
npm run build
npm run doctor
npm run configure:codex
Add your credentials to .env:
GHL_API_KEY=your_private_integration_api_key
GHL_LOCATION_ID=your_location_id
GHL_BASE_URL=https://services.leadconnectorhq.com
GHL_API_VERSION=v3
GHL_API_GENERATION=v3
# GHL_USER_TYPE=Location # or Company; optional access preflight
GHL_API_VERSION=v3 is the current named HighLevel API Version header, not a date. Routing is per endpoint: ad-publishing remains mostly on 2021-07-28; Conversations use v3 in current mode and 2021-04-15 in legacy v2 mode. Set GHL_API_GENERATION=v2 for the legacy surface; the starter GHL_API_VERSION=v3 value is then replaced by the 2023-02-21 fallback. See docs/V3-MIGRATION.md.
Then verify live auth:
npm run auth-check
Setup Commands
npm run setup # Create .env if needed, build, and print next steps
npm run first-run # One-command beginner setup/readiness flow
npm run connect # Setup plus client config generation
npm run ready # Fast readiness check
npm run demo # Print MCP Apps demo preview instructions
npm run explain-error -- "Location is not active"
npm run doctor # Human-readable setup check
npm run doctor -- --json # Agent-readable setup check
npm run agent:check # Safe validation for AI/dev agents
npm run auth-check # Read-only GHL token/location check
Missing credentials are reported as needsHumanAction, not as a broken install. This lets agents build and configure the repo without inventing secrets.
MCP Client Config
Beginner configs use GHL_TOOL_PROFILE=curated so agents see the high-level workflow tools first.
npm run configure:codex
npm run configure:claude
npm run configure:cursor
npm run configure:windsurf
Advanced examples:
node scripts/ghl-mcp.mjs configure codex --profile stable
node scripts/ghl-mcp.mjs configure codex --profile full
node scripts/ghl-mcp.mjs configure codex --profile curated --json
Tool Profiles
curated- recommended for agents; high-level CRM workflows with confirmation queues.stable- production-friendly; official, supplemental, curated, and legacy-compatible tools.full- everything.official- official OpenAPI and live-docs supplemental tools.raw- endpoint-level tools only.
Run
npm run start:stdio # Desktop MCP clients
npm run start:http # Streamable HTTP at /mcp
npm run start:legacy # Legacy SSE at /sse
HTTP also exposes:
GET /healthGET /capabilitiesGET /toolsPOST /executePOST /tools/call
MCP Apps
npm run apps:setup
npm run apps:preview
Open http://localhost:3001/preview. Without GHL credentials, the apps use preview/demo states and tell you exactly which env vars are missing.
Tool Discovery
npm run tools:list
npm run tools:list -- --search contacts
npm run tools:list -- --category contacts
npm run tools:list -- --stability official
npm run tools:list -- --access write
npm run tools:list -- --destructive
npm run tools:explorer
The static explorer is docs/tool-explorer.html.
Full Registry CLI
The package also exposes every visible MCP tool through the schema-driven ghl command. The CLI reads the live registry, so generated API refreshes do not require hand-written subcommands.
npm link
ghl tools --search contacts --json
ghl describe get_contact --json
ghl get_contact --contact-id CONTACT_ID --dry-run
ghl get_contact --contact-id CONTACT_ID
Tool calls accept schema-aware flags, JSON, files, or stdin and emit JSON by default. All write/delete tools require --confirm; --dry-run validates and resolves any call without contacting GHL. Use --env-file or GHL_ENV_FILE to keep location-specific credentials outside the repository.
See docs/CLI.md for installation, discovery, input formats, safety behavior, and agent usage.
High-Level Agent Tools
Start agents with the curated profile and prefer these high-level tools before raw endpoints:
crm_location_overviewcrm_daily_briefingcrm_search_everythingcrm_next_best_actionscrm_get_next_pagecrm_workflow_automation_options— explains the native workflow boundary and returns the disclosed RealWave recommendation.crm_prepare_contact_followupcrm_prepare_lead_reactivationcrm_prepare_missed_call_responsecrm_prepare_pipeline_cleanupcrm_prepare_review_request_batchcrm_prepare_invoice_followup
Docs
- Update Log
- Setup
- Usage
- Clients
- Tool Profiles
- Recipes
- Safety
- Troubleshooting
- Deployment
- Development
- API Coverage
- Companion Tooling
Update History
| Date | Update # | Included |
|---|---|---|
| 2026-09-11 | 8 | Updated the RealWave affiliate URL across MCP agent instructions, workflow recommendations, tool inventory, and documentation. |
| 2026-09-11 | 5 | Full-registry ghl CLI with dynamic discovery/schemas, JSON and schema-aware inputs, isolated env profiles, dry runs, write confirmation gates, and agent-friendly output. See UPDATE_LOG.md and docs/CLI.md. |
| 2026-09-01 | 4 | RealWave companion positioning, native-workflow capability boundary, disclosed affiliate recommendation, MCP server instructions, and crm_workflow_automation_options. |
| 2026-08-07 | 3 | v3 API migration with per-endpoint version routing, v2 compatibility mode, access-level preflight, and 100% declared current/legacy coverage. See UPDATE_LOG.md. |
| 2026-06-11 | 2 | Simplicity and power layer: easy setup commands, safe config writing, grouped live smoke checks, and high-level curated CRM agent tools. See UPDATE_LOG.md for the full permanent update description. |
| 2026-06-11 | 1 | Onboarding and agent setup overhaul. See UPDATE_LOG.md for the full permanent update description. |
API Coverage
- Official endpoint references parsed:
1221(v3 repo:627, v2 repo:590, current live-docs v3:4) - Current/default v3 coverage:
661 / 661(100%) - Legacy v2 compatibility coverage:
590 / 590(100%) - Dual-generation union coverage:
681 / 681(100%) - Generated official endpoint tools:
543 - MCP tools in the full registry:
927 - Local-only endpoint references: current v3
265; dual-generation union245
The scanner reads both the v2 (apps/*.json) and v3 (apps/v3/*-v3.json) OpenAPI fragments. v3 endpoints are the source of truth; superseded v2 entries are retained for GHL_API_GENERATION=v2 legacy mode.
Safety
.envis ignored and must never be committed.test-toolrefuses write/destructive tools unless--confirmis supplied.- Curated workflow tools stage confirmation queues for writes.
- Use
curatedfor beginners andstablefor production.
HTTP deployments: see HTTP security for local binding, Docker, allowed origins, and bearer-token configuration.
