Skip to main content
Glama
ghl-internal-cli

ghl-internal-cli

by drkavner

GHL Internal CLI

A command-line interface for accessing GoHighLevel's internal APIs, built on top of the ghl-internal-cli MCP server.

Installation

  1. Clone the repository:

    git clone https://github.com/drkavner/ghl-internal-cli.git
    cd ghl-internal-cli
  2. Install Python dependencies:

    pip install -r requirements.txt
  3. Set environment variables:

    export GHL_API_KEY=pit-your-private-integration-token
    export GHL_LOCATION_ID=your-location-id

Related MCP server: ghl-mcp-server

Usage

Run the CLI directly:

python3 cli.py <command> [options]

Or make it executable:

chmod +x cli.py
./cli.py <command> [options]

Available Commands

Agent Studio

  • agent-create - Create a new AI agent

    • --agentName (required) - Agent name

    • --agentPrompt (required) - System prompt

    • --welcomeMessage (required) - Welcome message

    • --locationId (optional) - Location ID (uses GHL_LOCATION_ID if omitted)

  • agent-list - List all AI agents

    • --locationId (optional) - Location ID

    • --limit (default: 100) - Number of results

    • --offset (default: 0) - Offset for pagination

  • agent-get - Get a specific agent by ID

    • --agentId (required) - Agent ID

    • --locationId (optional) - Location ID

  • agent-execute - Execute an AI agent

    • --agentId (required) - Agent ID

    • --message (required) - Message to send

    • --locationId (optional) - Location ID

    • --executionId (optional) - Session ID

Conversation AI (AskAI / AI Employees)

  • conv-create - Create a Conversation AI agent

    • --agentName (required) - Agent name

    • --agentRole (required) - Agent role/purpose

  • conv-search - Search Conversation AI agents

    • --query (required) - Search query

    • --limit (default: 100) - Maximum results

  • conv-get - Get a Conversation AI agent by ID

    • --agentId (required) - Agent ID

  • conv-update - Update a Conversation AI agent

    • --agentId (required) - Agent ID

    • --agentName (optional) - New agent name

    • --agentStatus (optional) - New status (e.g., active, paused)

  • conv-delete - Delete a Conversation AI agent

    • --agentId (required) - Agent ID

Voice AI

  • voice-create - Create a Voice AI agent

    • --agentName (required) - Agent name

    • --agentPrompt (required) - Agent prompt

    • --welcomeMessage (required) - Welcome message

    • --voiceId (required) - Voice ID

    • --locationId (optional) - Location ID

  • voice-list - List Voice AI agents

    • --locationId (optional) - Location ID

    • --page (default: 1) - Page number

    • --pageSize (default: 20) - Page size

  • voice-get - Get a Voice AI agent by ID

    • --agentId (required) - Agent ID

    • --locationId (optional) - Location ID

  • voice-delete - Delete a Voice AI agent

    • --agentId (required) - Agent ID

    • --locationId (optional) - Location ID

  • voice-logs - Get Voice AI call logs

    • --agentId (required) - Agent ID

    • --locationId (optional) - Location ID

    • --page (default: 1) - Page number

    • --pageSize (default: 20) - Page size

Knowledge Base

  • kb-list - List knowledge bases

    • --locationId (optional) - Location ID

  • kb-create - Create a knowledge base

    • --name (required) - Knowledge base name

    • --locationId (optional) - Location ID

  • kb-discover - Discover website pages for training

    • --knowledgeBaseId (required) - Knowledge base ID

    • --locationId (optional) - Location ID

    • --url (required) - URL to scan

  • kb-train - Train on discovered URLs

    • --knowledgeBaseId (required) - Knowledge base ID

    • --locationId (optional) - Location ID

    • --urls (required, space-separated) - URLs to train on

Vibe AI

  • vibe-chat - Get chat messages from a Vibe AI project

    • --projectId (required) - Project ID

    • --limit (default: 100) - Maximum messages

    • --offset (default: 0) - Offset for pagination

  • vibe-sandbox - Keep Vibe AI sandbox alive

    • --projectId (required) - Project ID

Funnels

  • funnel-create - Create a funnel

    • --name (required) - Funnel name

    • --description (optional) - Funnel description

  • funnel-step - Create a funnel step

    • --funnelId (required) - Funnel ID

    • --stepName (required) - Step name

    • --stepType (required) - Step type

    • --stepConfig (optional) - Step configuration (JSON string)

  • funnel-geo - Set geo-location targeting for a funnel

    • --funnelId (required) - Funnel ID

    • --latitude (required) - Latitude

    • --longitude (required) - Longitude

    • --radius (required) - Radius in meters

Feature Flags

  • feature-flags - Get feature flags for a location

    • --locationId (optional) - Location ID

Facebook Integration

  • fb-connection - Get Facebook connection for a location

    • --locationId (optional) - Location ID

  • fb-pages - Get linked Facebook pages for a location

    • --locationId (optional) - Location ID

Chat Widget

  • chat-widget - Get chat widget settings

    • --locationId (optional) - Location ID

WhatsApp Phone Numbers

  • whatsapp - Get WhatsApp phone numbers for a location

    • --locationId (optional) - Location ID

Forms

  • forms - Get forms

    • No arguments required

Custom Values

  • custom-values - Get custom values for a location

    • --locationId (optional) - Location ID

Payments Currency

  • payments-currency - Get payment currencies

    • No arguments required

Social Media Accounts

  • social-media - Get social media accounts for a location

    • --locationId (optional) - Location ID

Templates

  • templates - Get list of templates

    • No arguments required

Examples

# Create an AI agent
python3 cli.py agent-create --agentName "Support Bot" --agentPrompt "You are a helpful support agent." --welcomeMessage "Hello! How can I help you today?"

# List Voice AI agents
python3 cli.py voice-list

# Get chat messages from a Vibe AI project
python3 cli.py vibe-chat --projectId "your-project-id-here"

# Create a funnel
python3 cli.py funnel-create --name "Sales Funnel" --description "Funnel for converting leads to customers"

# Create a funnel step
python3 cli.py funnel-step --funnelId "your-funnel-id" --stepName "Email Sequence" --stepType "email" --stepConfig '{"emailTemplateId": "abc123"}'

# Set geo-location for a funnel
python3 cli.py funnel-geo --funnelId "your-funnel-id" --latitude 40.7128 --longitude -74.0060 --radius 10000

# Get feature flags
python3 cli.py feature-flags

# Get Facebook connection
python3 cli.py fb-connection

# Get WhatsApp phone numbers
python3 cli.py whatsapp

# Get forms
python3 cli.py forms

# Get custom values
python3 cli.py custom-values

# Get payment currencies
python3 cli.py payments-currency

# Get social media accounts
python3 cli.py social-media

# Get templates
python3 cli.py templates

Notes

  • All commands that require a location ID will use the GHL_LOCATION_ID environment variable if not explicitly provided.

  • For commands that accept JSON (like --stepConfig), pass a valid JSON string.

  • The CLI outputs JSON responses directly to stdout for easy processing with tools like jq.

Error Handling

The CLI will exit with code 1 and print an error message to stderr if:

  • Required arguments are missing

  • The API returns an error (non-2xx status code)

  • An unexpected exception occurs

Integration with Hermes Agent

This CLI shares the same underlying API logic as the MCP server (server.py). For use with Hermes Agent, prefer the MCP server integration as it provides native tool discovery and invocation capabilities.

License

MIT

Available Tools

47 tools
ghl_agent_studio_create_agentB

Create a new AI agent in Agent Studio

Inputs: locationId (required), agentName, agentPrompt, welcomeMessage.

ghl_agent_studio_execute_agentC

Execute an AI agent and get a response

Inputs: agentId (required), message (required), locationId (required), executionId.

ghl_agent_studio_get_agentA

Get a specific AI agent by ID

Inputs: agentId (required), locationId (required).

ghl_agent_studio_get_agentsB

List all AI agents in Agent Studio

Inputs: locationId (required), limit, offset.

ghl_chat_widget_getB

Get chat widget settings

Inputs: locationId (required).

ghl_conversation_ai_create_agentC

Create a Conversation AI agent (AskAI / AI Employee)

Inputs: agentName, agentRole.

ghl_conversation_ai_delete_agentB

Delete a Conversation AI agent

Inputs: agentId (required).

ghl_conversation_ai_get_agentA

Get a Conversation AI agent by ID

Inputs: agentId (required).

ghl_conversation_ai_search_agentsC

Search Conversation AI agents

Inputs: limit, query.

ghl_conversation_ai_update_agentB

Update a Conversation AI agent

Inputs: agentId (required), agentName, agentStatus.

ghl_custom_values_getC

Get custom values for a location

Inputs: locationId (required).

ghl_facebook_connection_getB

Get Facebook connection for a location

Inputs: locationId (required).

ghl_facebook_linked_pages_getB

Get linked Facebook pages for a location

Inputs: locationId (required).

ghl_feature_flags_getB

Get feature flags for a location

Inputs: locationId (required).

ghl_forms_getD

Get forms

Inputs: no named parameters.

ghl_funnel_createC

Create a funnel

Inputs: name (required), description.

ghl_funnel_create_stepC

Create a funnel step

Inputs: funnelId (required), stepName (required), stepType (required), stepConfig.

ghl_funnel_geo_locationB

Set geo-location targeting for a funnel

Inputs: radius (required), funnelId (required), latitude (required), longitude (required).

ghl_knowledge_base_createC

Create a knowledge base for AI training

Inputs: name (required), locationId (required).

ghl_knowledge_base_discover_websiteB

Discover website pages for knowledge base training

Inputs: url (required), locationId (required), knowledgeBaseId (required).

ghl_knowledge_base_listB

List all knowledge bases for a location

Inputs: locationId (required).

ghl_knowledge_base_train_urlsB

Train discovered URLs into a knowledge base (accepts an array of URLs)

Inputs: urls (required), locationId (required), knowledgeBaseId (required).

ghl_opportunities_getB

Get all opportunities for a location

Inputs: locationId (required), limit, offset, stageId, +1 more.

ghl_opportunity_createC

Create an opportunity

Inputs: title (required), stageId (required), locationId (required), pipelineId (required), +8 more.

ghl_opportunity_deleteB

Delete an opportunity

Inputs: locationId (required), opportunityId (required).

ghl_opportunity_getA

Get a specific opportunity by ID

Inputs: locationId (required), opportunityId (required).

ghl_opportunity_updateD

Update an opportunity

Inputs: locationId (required), opportunityId (required), tags, title, +9 more.

ghl_payments_currency_getB

Get payment currencies

Inputs: no named parameters.

ghl_pipeline_createC

Create a pipeline

Inputs: name (required), locationId (required), description.

ghl_pipeline_deleteC

Delete a pipeline

Inputs: locationId (required), pipelineId (required).

ghl_pipeline_getA

Get a specific pipeline by ID

Inputs: locationId (required), pipelineId (required).

ghl_pipelines_getA

Get all pipelines for a location

Inputs: locationId (required).

ghl_pipeline_stage_create_pipeline_stageB

Create a stage in a pipeline

Inputs: stageName (required), stageType (required), locationId (required), pipelineId (required), +1 more.

ghl_pipeline_stage_deleteB

Delete a pipeline stage

Inputs: stageId (required), locationId (required), pipelineId (required).

ghl_pipeline_stages_getA

Get all stages for a pipeline

Inputs: locationId (required), pipelineId (required).

ghl_pipeline_stage_updateC

Update a pipeline stage

Inputs: stageId (required), locationId (required), pipelineId (required), sort, +2 more.

ghl_pipeline_updateC

Update a pipeline

Inputs: locationId (required), pipelineId (required), name, description.

ghl_social_media_accounts_getC

Get social media accounts for a location

Inputs: locationId (required).

ghl_templates_listB

Get list of templates

Inputs: no named parameters.

ghl_vibe_ai_chat_getB

Get chat messages from a Vibe AI project

Inputs: projectId (required), limit, offset.

ghl_vibe_ai_sandbox_keepaliveC

Keep Vibe AI sandbox alive

Inputs: projectId (required).

ghl_voice_ai_create_agentC

Create a Voice AI agent

Inputs: locationId (required), voiceId, agentName, agentPrompt, +1 more.

ghl_voice_ai_delete_agentB

Delete a Voice AI agent

Inputs: agentId (required), locationId (required).

ghl_voice_ai_get_agentA

Get a Voice AI agent by ID

Inputs: agentId (required), locationId (required).

ghl_voice_ai_get_agentsC

List Voice AI agents

Inputs: locationId (required), page, pageSize.

ghl_voice_ai_get_call_logsC

Get Voice AI call logs

Inputs: agentId (required), locationId (required), page, pageSize.

ghl_whatsapp_phone_numbers_getA

Get WhatsApp phone numbers for a location

Inputs: locationId (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.6/5.0

    Scored across 47 tools

    Disambiguation4/5

    Most tools are clearly distinct, with domain prefixes (agent_studio, conversation_ai, voice_ai) preventing confusion between similar actions. However, pipeline naming is slightly ambiguous (ghl_pipelines_get vs ghl_pipeline_get) and ghl_pipeline_stage_create_pipeline_stage is redundant.

    Naming Consistency2/5

    Naming conventions are inconsistent: mixed use of 'list' and 'get' for retrieval actions (e.g., ghl_knowledge_base_list vs ghl_agent_studio_get_agents), inconsistent singular/plural (ghl_pipelines_get vs ghl_pipeline_get), and some actions lack verbs entirely (e.g., ghl_funnel_geo_location).

    Tool Count2/5

    With 47 tools, this is a very large toolset. While it covers many GHL domains, the count exceeds what is typical for a coherent CLI and feels overwhelming. The tool count itself suggests the server may be trying to cover too broad a scope.

    Completeness3/5

    Core CRUD is present for pipelines and opportunities, but several resources have notable gaps: knowledge base has create but no update/delete, agent studio lacks update/delete, and funnels have only create operations. These missing operations will require workarounds.

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables AI assistants to interact with GoHighLevel's CRM, marketing automation, and business management tools via the API v2, with support for contacts, conversations, calendars, opportunities, payments, and workflows.
      115 npm
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables AI agents to manage GoHighLevel workspaces through natural language, with 508 tools across 18 domains for complete CRM, marketing, and workflow automation.
      Apache 2.0
    • F
      license
      B
      quality
      C
      maintenance
      Enables AI assistants to operate GoHighLevel agencies through the official v2 API, managing contacts, deals, conversations, appointments, tags, custom fields, workflows, and pipeline reports with bulk operations and fail-closed security.
      12
      -