open-ghl-mcp

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 by default
• 🏢 Multi-location Support: Works with agency accounts to manage multiple sub-accounts
• 👥 Contact Management: Complete CRUD operations for contacts
• 💬 Conversations: Search conversations, view messages, and manage messaging
• 📝 Forms & Submissions: List forms, view submissions, test form submissions like a website visitor
• 🏷️ Tag Management: Add and remove tags from contacts
• 🔄 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

Use your own GoHighLevel Marketplace App:

1. Create your own GoHighLevel Marketplace App
2. Set the redirect URL to: http://localhost:8080/oauth/callback
3. Set the permissions you want for the tools and resources below

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

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

💬 Conversations & Messaging

🎯 Opportunities & Sales Pipeline

📅 Calendar & Appointments

📝 Forms & Submissions

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

💬 Conversation Resources

🎯 Opportunity Resources

📅 Calendar Resources

🔐 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 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.