一个强大的模型上下文协议(MCP)服务器,用于GoHighLevel API,提供管理联系人的工具。
克隆仓库:
git clone https://github.com/CallBackCode/ghlMCP.git
cd ghlMCP
安装依赖项:
npm install
设置您的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
构建项目:
npm run build
运行MCP服务器:
npm start
运行测试:
npm test
GHL_API_KEY(必需):您的GoHighLevel API密钥GHL_LOCATION_ID(必需):您的GoHighLevel位置ID可选:仅测试
GHL_TEST_BUSINESS_ID:用于基于业务ID的联系人测试GHL_TEST_CONTACT_ID:用于基于联系人ID的测试(如果需要)| 端点 | 描述 | 必需参数 | 可选参数 |
|---|---|---|---|
listContacts | 列出所有联系人 | locationId | |
getContact | 根据ID获取联系人 | id, locationId | |
createContact | 创建新的联系人 | locationId | firstName, lastName, email, phone |
updateContact | 根据ID更新联系人 | id, locationId | firstName, lastName, email, phone |
deleteContact | 根据ID删除联系人 | id, locationId | |
upsertContact | 更新或插入(创建/更新)联系人 | locationId, email | firstName, lastName, phone |
getContactsByBusinessId | 根据业务ID获取联系人 | businessId, locationId | limit, skip, query |
src/api/ — GoHighLevel端点的API封装src/types/ — 集中的TypeScript类型定义src/index.ts — MCP服务器入口点test/ — 每个端点的Jest测试套件提供方:CallBack