返回市场
高亮MCP

高亮MCP

作者:ModernTyrTech2 星标更新:2025-06-24

项目介绍

GoHighLevel MCP 服务器

一个强大的模型上下文协议(MCP)服务器,用于GoHighLevel API,提供管理联系人的工具。

安装

  1. 克隆仓库:

    git clone https://github.com/CallBackCode/ghlMCP.git
    cd ghlMCP
    
  2. 安装依赖项:

    npm install
    
  3. 设置您的GoHighLevel API密钥和位置ID:

    • 在项目根目录创建一个.env文件:

      cat <<EOF > .env
      # --- 必需:机构Token或位置Token及位置ID ---
      GHL_API_KEY=your_api_key_here
      GHL_LOCATION_ID=your_location_id_here
      
      # --- 可选:仅测试变量 ---
      
      GHL_TEST_BUSINESS_ID=your_business_id_here
      GHL_TEST_CONTACT_ID=your_contact_id_here
      
      EOF
      
  4. 构建项目:

    npm run build
    
  5. 运行MCP服务器:

    npm start
    
  6. 运行测试:

    npm test
    

环境变量

  • GHL_API_KEY(必需):您的GoHighLevel API密钥
  • GHL_LOCATION_ID(必需):您的GoHighLevel位置ID

可选:仅测试

  • GHL_TEST_BUSINESS_ID:用于基于业务ID的联系人测试
  • GHL_TEST_CONTACT_ID:用于基于联系人ID的测试(如果需要)

可用的MCP端点(工具)

<details> <summary><strong>联系人</strong></summary>
端点描述必需参数可选参数
listContacts列出所有联系人locationId
getContact根据ID获取联系人id, locationId
createContact创建新的联系人locationIdfirstName, lastName, email, phone
updateContact根据ID更新联系人id, locationIdfirstName, lastName, email, phone
deleteContact根据ID删除联系人id, locationId
upsertContact更新或插入(创建/更新)联系人locationId, emailfirstName, lastName, phone
getContactsByBusinessId根据业务ID获取联系人businessId, locationIdlimit, skip, query
</details>

项目结构

  • src/api/ — GoHighLevel端点的API封装
  • src/types/ — 集中的TypeScript类型定义
  • src/index.ts — MCP服务器入口点
  • test/ — 每个端点的Jest测试套件

注意事项

  • 所有端点都需要有效的GoHighLevel API密钥和位置ID。
  • 响应以适合LLM的文本格式返回为漂亮的JSON。
  • 详情请参阅GoHighLevel API 文档

提供方:CallBack