ClickFunnels MCP Framework 使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 协议构建的服务器，旨在将 ClickFunnels 2.0 平台的数据和功能集成到支持 MCP 协议的 LLM 客户端，例如 Claude Desktop。通过此服务器，您可以使用 Claude AI 访问和操作 ClickFunnels 2.0 账户中的数据，例如联系人、销售漏斗和订单信息。

主要功能点

连接 ClickFunnels 2.0 API: 安全连接到您的 ClickFunnels 2.0 账户。
数据访问工具: 提供工具来获取 ClickFunnels 中的关键数据，包括：
- 联系人列表: 检索您的联系人信息。
- 销售漏斗列表: 获取工作区中所有销售漏斗的列表。
- 订单列表: 查看您的订单信息。
- 销售漏斗详情: 获取指定销售漏斗的详细信息。
API 连接测试: 验证 ClickFunnels API 密钥是否配置正确且有效。

安装步骤

克隆仓库到本地:

git clone https://github.com/illGATESmusic/click-funnels-mcp-shared.git
cd click-funnels-mcp-shared

安装依赖: 确保您已安装 Node.js 18+ 及以上版本和 npm. 然后运行：
```
npm install
```

配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，然后根据您的 ClickFunnels 2.0 API 信息修改 '.env' 文件。您需要填写以下信息：

CLICKFUNNELS_API_BASE=https://your-workspace.myclickfunnels.com/api/v2  # 您的 ClickFunnels 2.0 工作区 API 基础 URL
CLICKFUNNELS_API_TOKEN=YOUR_API_TOKEN_HERE            # 您的 ClickFunnels 2.0 API 令牌
CLICKFUNNELS_WORKSPACE_ID=YOUR_WORKSPACE_ID_HERE      # 您的 ClickFunnels 2.0 工作区 ID
CLICKFUNNELS_WORKSPACE_SUBDOMAIN=your-workspace        # 您的 ClickFunnels 工作区子域名 (URL 中的子域名部分)
PORT=3002                                            # 服务器端口，默认 3002
NODE_ENV=production                                   # 运行环境，production 或 development
MCP_DISABLE_CONSOLE=true                              # 是否禁用控制台日志，true 禁用
MCP_HEALTH_INTERVAL=300000                             # 健康检查间隔 (毫秒)

如何获取 ClickFunnels 凭证:

API Base URL: 您的 ClickFunnels 2.0 工作区 URL，加上 '/api/v2' 后缀。
API Token: 在 ClickFunnels 2.0 后台，进入 "Settings" -> "API Keys" 创建并获取。
Workspace ID & Subdomain: 在 ClickFunnels 2.0 工作区设置中查找。

服务器配置 (用于 Claude Desktop 等 MCP 客户端)

要将此 MCP 服务器添加到 Claude Desktop，您需要在 Claude Desktop 的 MCP 服务器设置中添加一个新的服务器配置。配置信息如下 (JSON 格式):

{
  "server name": "clickfunnels-framework",
  "command": "node",
  "args": [
    "/path/to/your/clickfunnels-mcp-shared/src/index.js"  // **请替换为您的 clickfunnels-mcp-shared 仓库中 src/index.js 文件的实际绝对路径**
  ],
  "env": {
    "PORT": "3002",                                            // 服务器端口，与 .env 文件中配置的端口一致
    "CLICKFUNNELS_API_BASE": "https://your-workspace.myclickfunnels.com/api/v2",  // 您的 ClickFunnels 2.0 工作区 API 基础 URL，与 .env 文件中配置一致
    "CLICKFUNNELS_WORKSPACE_ID": "YOUR_WORKSPACE_ID",      // 您的 ClickFunnels 2.0 工作区 ID，与 .env 文件中配置一致
    "CLICKFUNNELS_API_TOKEN": "YOUR_API_TOKEN",            // 您的 ClickFunnels 2.0 API 令牌，与 .env 文件中配置一致
    "CLICKFUNNELS_WORKSPACE_SUBDOMAIN": "your-workspace",        // 您的 ClickFunnels 工作区子域名，与 .env 文件中配置一致
    "NODE_ENV": "production",                                   // 运行环境，与 .env 文件中配置一致
    "MCP_DISABLE_CONSOLE": "true"                              // 是否禁用控制台日志，与 .env 文件中配置一致
  }
}

请务必将 'args' 中的路径 '/path/to/your/clickfunnels-mcp-shared/src/index.js' 替换为您本地仓库 'src/index.js' 文件的实际绝对路径。 其他 'env' 中的配置项应与您在 '.env' 文件中的配置保持一致。

基本使用方法

启动服务器: 在仓库根目录下运行以下命令启动 MCP 服务器：
```
npm start
```
或在开发模式下使用热重载：
```
npm run dev
```
在 Claude Desktop 中添加服务器: 打开 Claude Desktop 应用，进入设置 (settings) -> MCP Servers，点击 "Add Server"，然后将上面提供的 JSON 配置信息粘贴进去。
使用 Claude 与 ClickFunnels 交互: 在 Claude Desktop 中，您现在可以使用 '@clickfunnels-framework' (或您在配置中设置的 "server name") 来调用此 MCP 服务器提供的工具。例如，您可以尝试以下指令：
- '@clickfunnels-framework test_connection' // 测试 API 连接
- '@clickfunnels-framework list_funnels' // 获取销售漏斗列表
- '@clickfunnels-framework list_contacts' // 获取联系人列表
Claude 将会调用 MCP 服务器上的相应工具，并返回 ClickFunnels 的数据，从而实现 AI 与您的 ClickFunnels 数据的交互。

关键词