关键词

GHL API 密钥管理子账户API 密钥自动生成GoHighLevel自动化

使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，它专注于与 Go High Level (GHL) 平台集成，实现子账户 API 密钥的自动化生成和管理。该服务器通过 MCP 协议，为 LLM 应用提供访问 GHL API 密钥的能力。

主要功能点

  • 自动化 GHL 登录: 服务器能够自动登录到 Go High Level 平台。
  • 子账户 API 密钥生成: 可以为 GHL 中的子账户自动生成 API 密钥。
  • API 密钥数据库存储: 生成的 API 密钥会被安全地存储在数据库中。
  • MCP 协议兼容: 完全遵循 MCP 协议规范，可以与任何 MCP 客户端进行交互。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/bpousa/ghl-mcp-integration.git
cd ghl-mcp-integration
  2. 安装依赖: 
    npm install
  3. 配置环境变量:
    • 复制 '.env.example' 文件并重命名为 '.env'。
    • 根据 '.env' 文件中的说明，填写你的 GHL 平台凭据和其他必要的配置信息。
  4. 创建数据库:
    • 使用 'src/database/schema.sql' 文件中的 SQL 脚本创建数据库和必要的表结构。你需要自行选择并配置数据库系统（例如 MySQL, PostgreSQL）。
  5. 启动服务器: 
    npm start
    服务器启动成功后，会在控制台输出 "MCP server started successfully"。

服务器配置 (MCP 客户端)

以下 JSON 配置信息用于 MCP 客户端连接到此 MCP 服务器。

{
  "serverName": "ghl-mcp-server",  // MCP 服务器名称，与 src/index.js 中定义的一致
  "command": "npm",             // 启动服务器的命令
  "args": ["start"]              // 启动命令的参数，这里表示执行 npm start
}

配置参数说明:

  • 'serverName': MCP 服务器的唯一标识名称。
  • 'command': 用于启动 MCP 服务器的可执行命令，通常是 Node.js 环境下的 'npm' 或 'node'。
  • 'args': 传递给 'command' 的参数数组，用于指定具体的启动命令，例如 'start' 脚本。

基本使用方法

  1. 连接 MCP 服务器: 在你的 MCP 客户端应用中，根据上述服务器配置信息连接到 'ghl-mcp-server'。
  2. 调用资源方法: 通过 MCP 客户端，你可以调用服务器提供的 'ghl-api-key' 资源的 'generateKey' 方法，并传入 'subAccountId' 作为参数，即可生成并获取指定子账户的 API 密钥。
    • 例如，使用 MCP 客户端发送请求调用 'ghl-api-key.generateKey' 方法，并提供子账户 ID。
  3. 处理响应: MCP 服务器将返回 JSON-RPC 响应，其中包含生成的 API 密钥或错误信息。

信息

分类

商业系统

访问项目