Ghl API MCP

ghl api mcp

ghl-api-mcp 是用于GoHighLevel文档的MCP stdio服务器。它允许代理搜索文档、列出端点并获取关注的API详细信息，而无需将大型markdown文件加载到提示上下文中。

此仓库不包括可运行的GoHighLevel OAuth/SSO示例应用程序；它包含文档和索引该文档的MCP文档服务器。

它做什么

服务器为以下标记文件建立索引 docs/ 并公开了MCP工具，用于：

• list_docs
• search_docs
• list_endpoints
• get_endpoint_details
• get_section
• get_document
• reload_docs

当前的语料库包括API审查文档、实现指南和操作说明，如OAuth/SSO集成详细信息和速率限制指南。要查看加载的内容，请运行 list_docs.

list_docs 将每个文件标记为 reference 或 guide.使用 get_document 当代理需要更长的程序文档的全文而不是单个提取部分时。

对于 search_docs, list_endpoints, get_endpoint_details，以及 get_section，您可以传递一个可选 whitelabel_domain 喜欢 api.example.com 或 https://api.example.com返回的端点URL和嵌入的示例URL将被重写到该域。

需求

• Node.js >=20 供当地使用
• Docker，如果你想运行容器化版本

快速开始

本地

npm install
npm start

或者直接运行CLI入口点：

npm install
./bin/ghl-api-mcp.js

重要提示：这是一个stdio MCP服务器。当您成功运行它时，它将保持连接状态并等待客户端请求。它不是HTTP服务器，也不打开端口。

码头工人

docker build -t ghl-api-mcp .
docker run --rm -i ghl-api-mcp

MCP客户端配置

本地回购结算

当存储库已存在于磁盘上时使用此选项：

{
  "mcpServers": {
    "ghl-docs": {
      "command": "node",
      "args": ["/absolute/path/to/ghl-api-mcp/src/server.js"]
    }
  }
}

本地回购结算与外部文档目录

{
  "mcpServers": {
    "ghl-docs": {
      "command": "node",
      "args": ["/absolute/path/to/ghl-api-mcp/src/server.js"],
      "env": {
        "GHL_DOCS_DIR": "/absolute/path/to/docs"
      }
    }
  }
}

码头工人

{
  "mcpServers": {
    "ghl-docs": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "ghl-api-mcp"]
    }
  }
}

Docker与外部文档目录

{
  "mcpServers": {
    "ghl-docs": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-v",
        "/absolute/path/to/docs:/docs:ro",
        "-e",
        "GHL_DOCS_DIR=/docs",
        "ghl-api-mcp"
      ]
    }
  }
}

文档加载

• 任何 .md 文件下 docs/ 自动索引
• 如果服务器已在运行，请调用 reload_docs 更改磁盘上的文档后
• 如果你将文档添加到仓库中，并在没有挂载文档目录的情况下通过Docker运行，请重建映像，使容器包含新文件

发展

npm install
npm test

报废工作流程

当GHL文档链接到更丰富的ClickUp内容时，使用浏览器支持的抓取器：

npm run scrape:page -- \
  --url https://marketplace.gohighlevel.com/docs/ghl/contacts/search-contacts-advanced \
  --output docs/generated/search-contacts-advanced.md

浏览器选择顺序：

1. 铬
2. 铬金丝雀
3. 禅

您可以用以下命令覆盖浏览器 --browser, --executablePath，或 PUPPETEER_EXECUTABLE_PATH.