mailmodo-mcp

Este es un proyecto TypeScript que implementa un servidor de Protocolo de control de mensajes (MCP) para la integración de Mailmodo con Claude Desktop y otros clientes compatibles con MCP.

Prerrequisitos

• Node.js (se recomienda v20 o superior)

• npm (viene con Node.js)

Related MCP server: MJML MCP Server

Instalación

Instalación mediante herrería

Para instalar Mailmodo Integration Server para Claude Desktop automáticamente a través de Smithery :

npx -y @smithery/cli install @mailmodo/mailmodo-mcp --client claude

Instalación manual

1. Clonar el repositorio:

git clone https://github.com/mailmodo/mailmodo-mcp.git
cd mailmodo-mcp

2. Instalar dependencias:

npm install

Construyendo el Proyecto

Para compilar el código TypeScript en JavaScript, ejecute:

npm run build

Esto creará un directorio dist que contendrá los archivos JavaScript compilados.

Ejecución del proyecto

Después de la construcción, puedes ejecutar el proyecto usando:

node dist/index.js

O utilice el script npm:

npm start

Configuración del escritorio de Claude

Ejecución local desde el código

Para configurar este proyecto con Claude Desktop, agregue la siguiente configuración a la configuración de Claude Desktop:

{
  "mcpServers": {
    "mailmodo": {
      "command": "node",
      "args": [
        "/path/to/your/mailmodo-mcp/dist/index.js"
      ]
    }
  }
}

Ejecutar desde la imagen de Docker

{
  "mcpServers": {
    "mailmodo": {
      "command": "docker",
      "args": [
        "run",
        "--platform", 
        "linux/amd64",
        "-i",
        "--rm",
        "-e",
        "MAILMODO_API_KEY",
        "avneesh001/mailmodo-mcp"
      ],
      "env": {
        "MAILMODO_API_KEY": "<GET MAILMODO KEY from https://manage.mailmodo.com/app/settings/apikey and insert here>"
      }
    }
  }
}

Ejecutar desde npx

{
  "mcpServers": {
    "mailmodo": {
      "command": "npx",
      "args": [
        "-y",
        "@mailmodo/mcp"
      ],
      "env": {
        "MAILMODO_API_KEY": "<GET MAILMODO KEY from https://manage.mailmodo.com/app/settings/apikey and insert here>"
      }
    }
  }
}

Conectarse a través del servidor remoto

{
  "mcpServers": {
    "mailmodo": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.app.mailmodo.com/mcp",
        "--header",
        "mmApiKey:${MAILMODO_API_KEY}"
      ],
      "env": {
        "MAILMODO_API_KEY": "<GET MAILMODO KEY from https://manage.mailmodo.com/app/settings/apikey and insert here>"
      }
    }
  }
}

Asegúrese de ajustar la ruta del archivo en la matriz args para que coincida con el directorio de su proyecto local.

Desarrollo

Para ejecutar el proyecto en modo de desarrollo con recompilación automática:

1. Instale ts-node y nodemon como dependencias de desarrollo:

npm install --save-dev ts-node nodemon

2. Agregue un script de desarrollo a su package.json:

{
  "scripts": {
    "dev": "nodemon src/index.ts",
    "build": "tsc",
    "start": "node dist/index.js"
  }
}

3. Ejecute el servidor de desarrollo:

npm run dev

Estructura del proyecto

mailmodo-mcp/
├── src/             # TypeScript source files
├── dist/            # Compiled JavaScript files
├── package.json     # Project dependencies and scripts
└── tsconfig.json    # TypeScript configuration

Herramientas y recursos

El servidor MCP de Mailmodo ofrece varias herramientas y recursos para interactuar con las funciones de Mailmodo. Aquí tienes una lista completa:

Recursos

1. Plantillas de Mailmodo ( mailmodo://templates )

   • Devuelve una lista de todas las plantillas de correo electrónico disponibles en formato JSON

   • Tipo MIME: aplicación/json

2. Campañas de Mailmodo ( mailmodo://campaigns )

   • Devuelve una lista de todas las campañas en formato JSON

   • Tipo MIME: aplicación/json

3. Listas de contactos de Mailmodo ( mailmodo://contact-lists )

   • Devuelve todas las listas de contactos en formato JSON

   • Tipo MIME: aplicación/json

Herramientas

1. Detalles del usuario

   • Nombre: userDetails

   • Descripción: Obtenga todos los detalles de un contacto

   • Parámetros:

     • email (cadena): Dirección de correo electrónico del contacto

2. Herramienta de informes de campañas

   • Nombre: MailmodoCampainReportTool

   • Descripción: Obtenga informes de campañas que incluyan recuentos de apertura, clics y envíos.

   • Parámetros:

     • campaignId (UUID): ID de la campaña

     • fromDate (AAAA-MM-DD): Fecha de inicio del informe

     • toDate (AAAA-MM-DD): Fecha de finalización del informe

3. Fecha y hora actuales

   • Nombre: currentDateTime

   • Descripción: Obtener fecha y hora actuales

   • Parámetros: Ninguno

4. Enviar evento

   • Nombre: sendEvent

   • Descripción: Envíe eventos personalizados con propiedades de evento y correo electrónico

   • Parámetros:

     • email (cadena): dirección de correo electrónico del contacto

     • event_name (cadena): Nombre del evento

     • ts (número, opcional): marca de tiempo

     • event_properties (objeto, opcional): Propiedades de evento adicionales

5. Gestión de listas de contactos

   • Agregar contacto a la lista

     • Nombre: addContactToList

     • Descripción: Agregar un solo contacto a una lista

     • Parámetros:

       • email (cadena): correo electrónico del contacto

       • listName (cadena): Nombre de la lista

       • data (objeto, opcional): Propiedades del contacto

       • Varios campos opcionales para metadatos de contacto

   • Agregar contactos en masa

     • Nombre: addBulkContactToList

     • Descripción: Agregue múltiples contactos a una lista en una sola operación

     • Parámetros:

       • listName (cadena): Nombre de la lista

       • values (matriz): Matriz de objetos de contacto

   • Eliminar contacto de la lista

     • Nombre: removeContactFromList

     • Descripción: Eliminar un contacto de una lista específica

     • Parámetros:

       • email (cadena): correo electrónico del contacto

       • listName (cadena): Nombre de la lista

6. Gestión del estado de los contactos

   • Darse de baja Contacto

     • Nombre: unsubscribeContact

     • Descripción: Dar de baja o suprimir un contacto

     • Parámetros:

       • email (cadena): correo electrónico del contacto

   • Volver a suscribirse Contacto

     • Nombre: resubscribeContact

     • Descripción: Volver a suscribir un contacto previamente dado de baja

     • Parámetros:

       • email (cadena): correo electrónico del contacto

   • Contacto de archivo

     • Nombre: archiveContact

     • Descripción: Archivar permanentemente un contacto

     • Parámetros:

       • email (cadena): correo electrónico del contacto

7. Gestión de campañas

   • Enviar campaña por correo electrónico

     • Nombre: sendEmailToCampaign

     • Descripción: Activar una campaña de correo electrónico con personalización

     • Parámetros:

       • campaignId (cadena): ID de campaña

       • email (cadena): correo electrónico del destinatario

       • Varios parámetros opcionales para personalización

   • Campaña de difusión

     • Nombre: broadcastCampaignToList

     • Descripción: Activar campañas para una lista de contactos completa

     • Parámetros:

       • campaignId (cadena): ID de campaña

       • listId (cadena): ID de la lista de destino

       • Parámetros opcionales para la personalización de campañas

Licencia

Licencia MIT