返回 MCP 目录
public公开dns本地运行

Kayzen Analytics

Kayzen Analytics的MCP服务器实现,提供标准接口访问广告数据分析

article

README

🚀 Kayzen Analytics MCP 服务器

Kayzen Analytics MCP 服务器是一个与 Kayzen Analytics API 交互的 Model Context Protocol (MCP) 服务器实现。它允许 AI 模型通过标准接口访问和分析 Kayzen 广告活动数据,为数据分析工作提供了便利。

🚀 快速开始

安装

npm install @feedmob-ai/kayzen-mcp

配置

创建一个 .env 文件,输入您的 Kayzen 资格信息:

KAYZEN_USERNAME=your_username
KAYZEN_PASSWORD=your_password
KAYZEN_BASIC_AUTH=your_basic_auth_token
KAYZEN_BASE_URL=https://api.kayzen.io/v1  # 可选,默认为此值

基本设置

import { KayzenMCPServer } from '@feedmob-ai/kayzen-mcp';

const server = new KayzenMCPServer();
server.start();

✨ 主要特性

  • 自动化认证:内置令牌管理,带有自动刷新机制。
  • 报告管理:轻松访问 Kayzen 分析报告。
  • 错误处理:全面的 API 交互错误处理。
  • TypeScript 支持:完整的 TypeScript 实现及类型定义。
  • 基于环境的配置:使用环境变量进行简单设置。

💻 使用示例

基础用法

以下是启动服务器的基本代码:

import { KayzenMCPServer } from '@feedmob-ai/kayzen-mcp';

const server = new KayzenMCPServer();
server.start();

高级用法

1. list_reports

列出 Kayzen Analytics 所有可用的报告。

const reports = await server.tools.list_reports();

输入:无 返回:包含以下内容的报告对象数组:

  • id:报告标识符
  • name:报告名称
  • type:报告类型

2. get_report_results

获取特定报告的结果。

const results = await server.tools.get_report_results({
  report_id: 'report_id',
  start_date: '2024-01-01',  // 可选
  end_date: '2024-01-31'     // 可选
});

输入

  • report_id (字符串,必需):要获取的报告 ID
  • start_date (字符串,可选):起始日期,格式为 YYYY-MM-DD
  • end_date (字符串,可选):结束日期,格式为 YYYY-MM-DD 返回:报告数据及元数据

3. analyze_report_results(提示)

分析报告结果并提供见解。

// 代码示例暂未给出,可根据实际情况调用

输入

  • report_id (字符串):要分析的报告 ID 分析包括
  • 性能指标
  • 关键趋势
  • 优化领域
  • 异常模式或异常

📚 详细文档

设置

与 Claude Desktop 使用

要在 Claude Desktop 上使用,请在 claude_desktop_config.json 中添加以下内容:

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": [
        "-y",
        "@feedmob-ai/kayzen-mcp"
      ],
      "env": {
        "KAYZEN_USERNAME": "username",
        "KAYZEN_PASSWORD": "pasword",
        "KAYZEN_BASIC_AUTH": "认证令牌"
      }
    }
  }
}

开发

先决条件

  • Node.js (v16 或更高版本)
  • npm (v7 或更高版本)
  • Kayzen API 资格信息

脚本

# 安装依赖项
npm install

# 构建项目
npm run build

# 启动服务器
npm start

# 开发模式(带有热重载)
npm run dev

项目结构

kayzen-mcp/
├── src/
│   ├── server.ts        # MCP 服务器实现
│   └── kayzen-client.ts # Kayzen API 客户端
├── dist/               # 编译后的 JavaScript
└── package.json       # 项目配置

依赖项

主要依赖项: | 依赖项 | 版本 | | ---- | ---- | | @modelcontextprotocol/sdk | ^1.7.0 | | axios | ^1.8.3 | | dotenv | ^16.4.7 | | zod | ^3.24.2 |

错误处理

服务器处理各种错误场景:

  • 认证失败
  • 无效的 API 请求
  • 网络问题
  • 令牌自动刷新
  • 项目结构和依赖项部分也清晰易懂,符合中文阅读习惯。
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端