GoHighLevel MCP Server

A Model Context Protocol (MCP) server that provides seamless integration with the GoHighLevel API v2. This server enables AI assistants to interact with GoHighLevel's CRM functionality, starting with comprehensive contact management.

Features

• 🔐 OAuth 2.0 Authentication: Full OAuth flow with automatic token management
• 🏢 Agency or sub-account scope: An agency (Company) token manages every sub-account via automatic agency→location token exchange; a sub-account (Location) token is used directly and is locked to that one sub-account
• 👥 Curated domains: Contacts, conversations & messaging, opportunities & pipelines, calendars & appointments, forms, custom fields & values, notes & tasks, users, and workflows — typed tools that handle API quirks
• 🌐 Full-surface gateway: ghl_list_endpoints + ghl_request reach the entire GoHighLevel v2 API (the long tail beyond the curated tools), with automatic token routing, quirk normalization, and confirmation gating on destructive/high-impact writes
• 🔄 Automatic Token Refresh: Handles token expiration seamlessly
• 🛠️ MCP Tools & Resources: Both tools and resources for flexible integration

Prerequisites

• Python 3.12+
• uv package manager (or pip)
• One of the following:
  • Standard Mode Configuration: Access via our hosted GoHighLevel app (coming soon)
  • Custom Mode Configuration: Your own GoHighLevel Marketplace App credentials

Getting Started - Installation

1. Clone the repository:

git clone https://github.com/basicmachines-co/open-ghl-mcp.git
cd open-ghl-mcp

2. Install dependencies:

uv venv
source .venv/bin/activate
uv pip install -r requirements.txt

3. Start the server:

python -m src.main

1. Configuration

Basic Machines team members: skip this — use the shared app credentials from 1Password and follow Team Setup instead of creating your own app.

For external/self-hosted use, create your own GoHighLevel Marketplace App:

1. Create your own GoHighLevel Marketplace App
2. Set the redirect URL to: http://localhost:8080/oauth/callback
3. Enable the scopes you want for the tools below (the server requests its full ALL_SCOPES set at authorization; the granted token is the intersection of that and the scopes your app enables)

2. Usage

Running the MCP Server

1. Start the server:

python -m src.main

2. Complete the setup wizard.

3. Configure your LLM to use the MCP server

First-time Authentication

Custom Mode Setup

1. The server will ask you for your GHL Marketplace App Client ID and Secret
2. Install your App to generate an OAuth Token

Team Setup (Basic Machines)

For internal team members. The goal is Admin access to a single sub-account (no agency-wide access): you authorize as a Sub-Account Admin and receive a Location token that is locked to your one sub-account — the server will refuse any other location.

You point your coding agent at this repo and ask it to install the server. The agent can do every step except the browser consent — that one is yours (you have to click "Allow" while signed in as the right GHL user).

Prerequisites

• Python 3.12+ and the uv package manager
• A GoHighLevel Sub-Account Admin login on the sub-account you'll manage (ask an agency admin to create one — not an agency-level user)
• Access to the team 1Password vault item "GoHighLevel MCP — App Credentials" (holds GHL_CLIENT_ID and GHL_CLIENT_SECRET for the shared Basic Machines app — do not create your own marketplace app)

Steps

1. Clone & install

   git clone https://github.com/basicmachines-co/open-ghl-mcp.git
   cd open-ghl-mcp
   uv venv && source .venv/bin/activate
   uv pip install -r requirements.txt

2. Create .env from the template, filling the two secrets from 1Password:

   cp .env.example .env
   # then set GHL_CLIENT_ID and GHL_CLIENT_SECRET from the 1Password item

3. Authorize (interactive — the human step)

   • In your browser, sign in to GoHighLevel as your Sub-Account Admin user (use an incognito window if you're also logged in as an agency user — the logged-in user determines the token you get).
   • Run the OAuth flow:

     uv run python -m src.main --reauth

   • Approve in the browser and select your sub-account. You'll get a Location token scoped to just that sub-account; the command prints the number of granted scopes.

4. Register the server with your MCP client

   • Claude Code (replace the path with your clone's absolute path):

     claude mcp add ghl -s user -- uv run --directory /absolute/path/to/open-ghl-mcp python -m src.main

   • Claude Desktop — add to claude_desktop_config.json:

     {
       "mcpServers": {
         "ghl": {
           "command": "uv",
           "args": ["run", "--directory", "/absolute/path/to/open-ghl-mcp", "python", "-m", "src.main"]
         }
       }
     }

5. Restart your MCP client so it loads the ghl tools (a server added mid-session isn't picked up until restart).

Notes

• Re-authorize anytime (e.g. after the app's scopes change): uv run python -m src.main --reauth — it backs up your existing token first.
• Sub-account isolation: your token only works for your own sub-account; requests to any other location are refused with a clear error.
• Agency owners who authorize get a Company token instead, which manages all sub-accounts via automatic location-token exchange.

API Reference

This MCP server provides comprehensive access to GoHighLevel API v2 through both Tools (for actions) and Resources (for data browsing). All endpoints are fully tested and validated.

🛠️ MCP Tools (Actions)

👥 Contact Management

Tool	GoHighLevel Endpoint	Description
create_contact	POST /contacts	Create a new contact
update_contact	PUT /contacts/{id}	Update existing contact
delete_contact	DELETE /contacts/{id}	Delete a contact
get_contact	GET /contacts/{id}	Get a single contact
search_contacts	GET /contacts	Search contacts with filters
add_contact_tags	POST /contacts/{id}/tags	Add tags to a contact
remove_contact_tags	DELETE /contacts/{id}/tags	Remove tags from a contact

💬 Conversations & Messaging

Tool	GoHighLevel Endpoint	Description
get_conversations	GET /conversations/search	Search and list conversations
get_conversation	GET /conversations/{id}	Get a single conversation
get_messages	GET /conversations/{id}/messages	Get messages from a conversation
send_message	POST /conversations/{id}/messages	Send messages (SMS ✅, Email ✅, WhatsApp, IG, FB, Custom, Live_Chat)
update_message_status	PUT /conversations/messages/{messageId}/status	Update message delivery status

🎯 Opportunities & Sales Pipeline

Tool	GoHighLevel Endpoint	Description
get_opportunities	GET /opportunities/search	Search opportunities with filters
get_opportunity	GET /opportunities/{id}	Get a single opportunity
create_opportunity	POST /opportunities	Create new opportunity
update_opportunity	PUT /opportunities/{id}	Update existing opportunity
delete_opportunity	DELETE /opportunities/{id}	Delete opportunity
update_opportunity_status	PUT /opportunities/{id}/status	Update opportunity status
get_pipelines	GET /opportunities/pipelines	List all pipelines

📅 Calendar & Appointments

Tool	GoHighLevel Endpoint	Description
get_calendars	GET /calendars/?locationId={id}	List all calendars for location
get_calendar	GET /calendars/{id}	Get calendar details (54+ fields)
get_appointments	GET /contacts/{contactId}/appointments	Get appointments for contact
get_free_slots	GET /calendars/{id}/free-slots	Get available time slots

📝 Forms & Submissions

Tool	GoHighLevel Endpoint	Description
get_forms	GET /forms	List all forms (basic info: id, name, locationId)
get_all_form_submissions	GET /forms/submissions	Get all submissions with filtering
upload_form_file	POST /forms/upload-custom-files	Upload file to custom field

Note: Limited API support for forms. The following are NOT available:

• GET /forms/{id} (401 "Route not supported")
• GET /forms/{id}/submissions (404 Not Found)
• POST /forms/submit (401 Unauthorized)

📖 MCP Resources (Data Browsing)

👥 Contact Resources

Resource URI	GoHighLevel Endpoint	Description
contacts://{location_id}	GET /contacts	Browse all contacts for location
contact://{location_id}/{contact_id}	GET /contacts/{id}	View single contact details

💬 Conversation Resources

Resource URI	GoHighLevel Endpoint	Description
conversations://{location_id}	GET /conversations/search	Browse all conversations for location
conversation://{location_id}/{conversation_id}	GET /conversations/{id}	View conversation with messages

🎯 Opportunity Resources

Resource URI	GoHighLevel Endpoint	Description
opportunities://{location_id}	GET /opportunities/search	Browse all opportunities for location
opportunity://{location_id}/{opportunity_id}	GET /opportunities/{id}	View single opportunity details
pipelines://{location_id}	GET /opportunities/pipelines	Browse all pipelines with stages

📅 Calendar Resources

Resource URI	GoHighLevel Endpoint	Description
calendars://{location_id}	GET /calendars/	Browse all calendars for location
calendar://{location_id}/{calendar_id}	GET /calendars/{id}	View calendar details
appointments://{location_id}/{contact_id}	GET /contacts/{id}/appointments	Browse appointments for contact

🔐 Authentication Requirements

All endpoints require proper authentication:

• Company Token: Used for location token exchange
• Location Token: Required for all location-specific operations (expires every 24 hours)
• Automatic Refresh: The MCP server handles token refresh automatically

📋 Example Usage

# Get all contacts for your location
contacts://YOUR_LOCATION_ID

# Get specific contact details
contact://YOUR_LOCATION_ID/YOUR_CONTACT_ID

# Browse appointments for a contact
appointments://YOUR_LOCATION_ID/YOUR_CONTACT_ID

# Browse opportunities for your location
opportunities://YOUR_LOCATION_ID

# View conversation details
conversation://YOUR_LOCATION_ID/YOUR_CONVERSATION_ID

Development

Testing

For local testing with real GoHighLevel accounts, you'll need:

• A GoHighLevel account with API access
• At least one sub-account (location) for testing
• Test contacts and data in your GoHighLevel instance

Create your own testing guidelines and keep sensitive data like location IDs and contact IDs in local files that are not committed to the repository.

Running Tests

# Run all tests
uv run pytest

# Run tests with coverage report
uv run pytest --cov=src --cov-report=term-missing

# Run specific test file
uv run pytest tests/test_api_client.py -v

Code Quality

This project uses automated code quality tools. Before committing changes:

# Format code with Black
uv run black src/ tests/

# Check linting with flake8
uv run flake8 src/ tests/

# Run type checking with mypy
uv run mypy src/ --ignore-missing-imports

# Run all checks at once
uv run black src/ tests/ && uv run flake8 src/ tests/ && uv run mypy src/ --ignore-missing-imports

Pre-commit Hook (optional)

To automatically format code before commits:

# Create a git pre-commit hook
echo '#!/bin/sh
uv run black src/ tests/
uv run flake8 src/ tests/
' > .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

Continuous Integration

The project uses GitHub Actions for CI/CD:

• Tests run automatically on all pushes and pull requests
• Tested with Python 3.12 and 3.13
• Includes linting, type checking, and test coverage
• Coverage reports are uploaded to Codecov (if configured)

Architecture

The server follows a modular architecture:

• OAuth Service: Handles authentication and token management
• API Client: Manages communication with GoHighLevel API
• MCP Server: FastMCP-based server exposing tools and resources
• Data Models: Pydantic models for data validation

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For issues and feature requests, please use the GitHub issues tracker.