Servidor MCP de Kayzen Analytics
Una implementación de servidor de Protocolo de Contexto de Modelo (MCP) para interactuar con la API de Kayzen Analytics. Este paquete permite a los modelos de IA acceder y analizar los datos de las campañas publicitarias de Kayzen a través de una interfaz estandarizada.
Características
- Autenticación automatizada: Gestión de tokens integrada con mecanismo de actualización automática
- Gestión de informes: Fácil acceso a los informes analíticos de Kayzen
- Gestión de errores: Gestión integral de errores en las interacciones con la API
- Compatibilidad con TypeScript: Implementación completa de TypeScript con definiciones de tipos
- Configuración basada en el entorno: Configuración sencilla mediante variables de entorno
Instalación
npm install @feedmob-ai/kayzen-mcp
Configuración
Crea un archivo .env
con tus credenciales Kayzen:
KAYZEN_USERNAME=tu_nombre_de_usuario KAYZEN_PASSWORD=tu_contraseña KAYZEN_BASIC_AUTH=tu_auth_token_basico KAYZEN_BASE_URL=https://api.kayzen.io/v1 # Opcional, por defecto este valor
Uso
Configuración básica
import { KayzenMCPServer } from '@feedmob-ai/kayzen-mcp'; const server = new KayzenMCPServer(); server.start()
Herramientas disponibles
1. list_reports
Lista todos los informes disponibles de Kayzen Analytics.
- Entradas: Ninguno
- Devuelve: Array de objetos de informe que contienen
id
: Identificador del informename
: Nombre del informetipo
: Tipo de informe
const reports = await servidor.herramientas.list_reportes()
2. get_report_results
Recupera los resultados de un informe específico.
- Entradas
report_id
(cadena, obligatorio): ID del informe a recuperarstart_date
(cadena, opcional): Fecha de inicio en formato AAAA-MM-DDend_date
(cadena, opcional): Fecha final en formato AAAA-MM-DD
- Devuelve: Datos y metadatos del informe
const results = await server.tools.get_report_results({ report_id: 'report_id', start_date: '2024-01-01', // opcional end_date: '2024-01-31' // opcional })
3. analyze_report_results
(Preguntar)
Analiza los resultados del informe y proporciona información.
- Entradas
report_id
(cadena): ID del informe a analizar
- El análisis incluye
- Métricas de rendimiento
- Tendencias clave
- Áreas de optimización
- Patrones o anomalías inusuales
Configuración
Uso con Claude Desktop
Para utilizarlo con Claude Desktop, añada lo siguiente a su claude_desktop_config.json
:
NPX
{ "mcpServers": { "github": { "command": "npx", "args": [ "-y", "@feedmob-ai/kayzen-mcp" ], "env": { "KAYZEN_USERNAME": "nombre_usuario", "KAYZEN_PASSWORD": "pasword", "KAYZEN_BASIC_AUTH": "auth token" } } }
Desarrollo
Requisitos previos
- Node.js (v16 o superior)
- npm (v7 o superior)
- Credenciales de la API de Kayzen
Scripts
# Install dependencies npm install # Build the project npm run build # Start the server npm start # Development mode with hot-reload npm run dev
Estructura del proyecto
kayzen-mcp/ ├── src/ │ ├─── server.ts # Implementación del servidor MCP │ └── kayzen-client.ts # Kayzen API client ├── dist/ # JavaScript compilado └── package.json # Configuración del proyecto
Dependencias
Dependencias principales:
@modelcontextprotocol/sdk
: ^1.7.0axios
: ^1.8.3dotenv
: ^16.4.7zod
: ^3.24.2
Tratamiento de errores
El servidor maneja varios escenarios de error:
- Fallos de autenticación
- Peticiones de API no válidas
- Problemas de red
- Expiración y actualización de token
- Parámetros no válidos
Licencia
Licencia MIT
Autor
FeedMob