FastAlert MCP Server

Servidor oficial del Protocolo de Contexto de Modelo (MCP) para FastAlert. Este servidor permite que agentes de IA (como Claude, ChatGPT y Cursor) listen tus canales y envíen notificaciones directamente a través de la API de FastAlert.

Documentación

Servidor MCP de FastAlert

Servidor oficial del Model Context Protocol (MCP) para FastAlert. Este servidor permite a los agentes de IA (como Claude, ChatGPT y Cursor) listar tus canales y enviar notificaciones directamente a través de la API de FastAlert.

Características

  • Descubrimiento de canales: Lista todos tus canales con filtrado opcional por nombre.
  • Envío de notificaciones: Envía mensajes enriquecidos (título, contenido, acciones, imágenes) a uno o varios canales.

Inicio rápido

{
  "mcpServers": {
    "fastalert": {
      "command": "npx",
      "args": ["-y", "fastalert-mcp-server"],
      "env": {
        "API_KEY": "your-api-key-here"
      }
    }
  }
}

Puedes encontrar tu clave de API visitando FastAlert y navegando a Configuración.

Herramientas disponibles

Las siguientes herramientas están disponibles a través de este servidor MCP. Cada herramienta puede ser llamada por un asistente de IA para realizar acciones específicas.

1. list_channels

Devuelve una lista de canales FastAlert disponibles.

Parámetros de entrada:

  • name (cadena, opcional): Un término de búsqueda para filtrar canales por nombre.

Ejemplo de llamada:

{
  "name": "Service Alerts"
}

Salida JSON estructurada (por defecto):

{
  "status": true,
  "message": "You have fetch channels successfully",
  "data": {
    "channels": [
      {
        "uuid": "sdf12sdf-6541-5d56-s5sd-1fa513e88a81",
        "name": "Service Alerts",
        "subscriber": 1000
      }
    ]
  }
}

Salida de texto legible por humanos:

Here are your FastAlert channels:

Service Alerts
UUID: sdf12sdf-6541-5d56-s5sd-1fa513e88a81
Subscribers: 1000

2. send_message

Envía un mensaje de notificación a uno o más canales.

Parámetros de entrada:

  • channel-uuid (cadena, obligatorio): El identificador único del canal de destino.
  • title (cadena, obligatorio): El título de la notificación de alerta.
  • content (cadena, obligatorio): El texto principal del cuerpo de la notificación.
  • action (cadena, opcional): Tipo de acción ('call', 'email', 'website', 'image').
  • action_value (cadena, opcional): El valor para la acción (por ejemplo, una URL o número de teléfono).
  • image (cadena, opcional): URL o identificador de una imagen para incluir.

Ejemplo de llamada:

{
  "channel-uuid": "sdf12sdf-6541-5d56-s5sd-1fa513e88a81",
  "title": "System Update",
  "content": "A new version of the system is now live.",
  "action": "website",
  "action_value": "https://fastalert.now/updates"
}

Salida JSON estructurada (por defecto):

{
  "status": true,
  "message": "Message has been sent successfully"
}

Salida de texto legible por humanos:

Message Sent Successfully!

Your message "System Update" has been sent to Service Alerts.

Channel UUID: sdf12sdf-6541-5d56-s5sd-1fa513e88a81
Title: System Update
Content: A new version of the system is now live.

Integración con LLMs

Configuración en Cursor

  1. Ve a Configuración -> MCP.
  2. Haz clic en Agregar nuevo servidor MCP.
  3. Nombre: FastAlert
  4. Tipo: command
  5. Comando: npx -y fastalert-mcp-server
  6. Env: Agrega API_KEY.

Configuración en ChatGPT

  1. Ve a Configuración -> Integraciones.
  2. Haz clic en Agregar servidor MCP.
  3. Usa la URL alojada de tu servidor (por ejemplo, https://mcp.fastalert.now/mcp).
  4. Sigue las indicaciones de OAuth.

Configuración en Claude

  1. Abre claude_desktop_config.json.
  2. Agrega la siguiente entrada:
{
  "mcpServers": {
    "fastalert": {
      "command": "npx",
      "args": ["-y", "fastalert-mcp-server"],
      "env": {
        "API_KEY": "your-api-key-here"
      }
    }
  }
}

Configuración y desarrollo

Requisitos

  • Node: Se recomienda la versión 18 o superior.
  • API_KEY: Se requiere una clave de API de FastAlert válida para la autenticación.

Instalación local

  1. Clona el repositorio
  2. Copia el archivo de entorno de ejemplo:
    cp .env.example .env
    
  3. Configura tus variables de entorno en .env.
  4. Instala las dependencias:
    npm install
    
  5. Compila el proyecto:
    npm run build
    
  6. Ejecuta las pruebas del inspector:
    npm run inspector
    
  7. Ejecuta localmente:
    npm start
    

Configuración (Variables de entorno)

Las siguientes variables de entorno deben configurarse en tu archivo .env:

VariableDescripciónEjemplo
API_URLEl endpoint de la API de FastAlerthttps://api.fastalert.now/api
FRONT_URLLa URL de tu aplicación frontendhttps://fastalert.now
BASE_URLLa URL pública donde está alojado este servidor MCPhttp://localhost:3000
API_KEYTu clave de API de FastAlertyour-api-key-here
PORT(Opcional) Puerto para ejecutar el servidor3000

Contribuciones

¡Las contribuciones son bienvenidas! No dudes en enviar un Pull Request.

Licencia

Este proyecto está licenciado bajo la Licencia MIT.