Kayzen Analytics MCP Server 使用说明

项目简介

Kayzen Analytics MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它允许大型语言模型 (LLM) 通过标准化的方式访问和分析 Kayzen 广告平台的数据。该服务器提供了一系列工具和 Prompt,使 LLM 能够查询广告报表、获取数据结果,并进行深入分析,为营销决策提供数据支持。

主要功能点

  • 数据访问能力: 通过工具 (Tools) 提供对 Kayzen Analytics 广告数据的访问接口。
  • 报表管理: 支持列出可用的 Kayzen 报表,并获取指定报表的详细数据。
  • 数据分析: 提供 Prompt 模板,引导 LLM 分析报表数据,提取关键洞察。
  • 自动化鉴权: 内置 Token 管理和自动刷新机制,简化 API 认证流程。
  • 标准化接口: 遵循 MCP 协议,提供与 LLM 客户端集成的标准方法。

安装步骤

  1. 安装 npm 包: 打开终端,运行以下命令安装 Kayzen MCP Server npm 包:
    npm install @feedmob-ai/kayzen-mcp

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)连接到 Kayzen MCP Server,您需要配置客户端的 'claude_desktop_config.json' 文件。以下是一个配置示例,用于通过 'npx' 启动 Kayzen MCP Server。

{
  "mcpServers": {
    "kayzen": {
      "command": "npx",
      "args": [
        "-y",
        "@feedmob-ai/kayzen-mcp"
      ],
      "env": {
        "KAYZEN_USERNAME": "<your_kayzen_username>",  // 替换为您的 Kayzen 用户名
        "KAYZEN_PASSWORD": "<your_kayzen_password>",  // 替换为您的 Kayzen 密码
        "KAYZEN_BASIC_AUTH": "<your_kayzen_basic_auth_token>" // 替换为您的 Kayzen Basic Auth Token
      }
    }
  }
}

配置参数说明:

  • 'server name': 'kayzen' (可以自定义,用于在客户端中标识该 MCP 服务器)
  • 'command': 'npx' (Node Package Execute,用于执行 npm 包)
  • 'args':
    • '-y': (可选) 自动确认执行 npm 包
    • '@feedmob-ai/kayzen-mcp': Kayzen MCP Server 的 npm 包名称,npx 将执行该包的入口文件。
  • 'env': 环境变量配置,Kayzen MCP Server 需要以下环境变量进行身份验证和 API 连接:
    • 'KAYZEN_USERNAME': 您的 Kayzen 用户名
    • 'KAYZEN_PASSWORD': 您的 Kayzen 密码
    • 'KAYZEN_BASIC_AUTH': 您的 Kayzen Basic Auth Token
    • 'KAYZEN_BASE_URL': (可选) Kayzen API 基础 URL,默认为 'https://api.kayzen.io/v1'

请务必将 '<your_kayzen_username>'、'<your_kayzen_password>' 和 '<your_kayzen_basic_auth_token>' 替换为您的实际 Kayzen API 凭据。

基本使用方法

配置完成后,MCP 客户端(如 Claude Desktop)将能够连接到 Kayzen MCP Server 并使用其提供的工具和 Prompt。

可用工具 (Tools):

  1. 'list_reports': 列出 Kayzen Analytics 中所有可用的报表。无需任何输入参数。

    • 返回值:包含报表对象数组,每个对象包含 'id' (报表 ID)、'name' (报表名称) 和 'type' (报表类型)。
  2. 'get_report_results': 获取指定报表的详细结果数据。

    • 输入参数:
      • 'report_id' (string, 必填): 要获取结果的报表 ID。
      • 'start_date' (string, 可选): 起始日期,格式为 YYYY-MM-DD。
      • 'end_date' (string, 可选): 结束日期,格式为 YYYY-MM-DD。
    • 返回值:包含报表数据和元数据的 JSON 对象。

可用 Prompt (Prompts):

  1. 'analyze_report_results': 分析指定报表的结果,提供数据洞察。
    • 输入参数:
      • 'report_id' (string): 要分析的报表 ID。
    • 描述:该 Prompt 指示 LLM 分析指定报表的性能指标、关键趋势、优化方向和异常模式。

使用示例 (概念性):

在 MCP 客户端中,您可以选择 'kayzen' 服务器,并调用相应的工具或 Prompt 来与 Kayzen Analytics 数据进行交互。例如,您可以先使用 'list_reports' 工具获取可用的报表列表,然后选择一个 'report_id',使用 'get_report_results' 工具获取报表数据,最后使用 'analyze_report_results' Prompt 指示 LLM 分析该报表数据。

请参考您的 MCP 客户端的具体文档,了解如何在客户端界面中配置和使用 MCP 服务器及其提供的工具和 Prompt。

信息

分类

商业系统