mailmodo-mcp

Dies ist ein TypeScript-Projekt, das einen Message Control Protocol (MCP)-Server für die Mailmodo-Integration mit Claude Desktop und anderen MCP-unterstützten Clients implementiert.

Voraussetzungen

• Node.js (v20 oder höher empfohlen)

• npm (wird mit Node.js geliefert)

Related MCP server: MJML MCP Server

Installation

Installation über Smithery

So installieren Sie den Mailmodo Integration Server für Claude Desktop automatisch über Smithery :

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

Manuelle Installation

1. Klonen Sie das Repository:

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

2. Installieren Sie Abhängigkeiten:

npm install

Erstellen des Projekts

Um den TypeScript-Code in JavaScript zu kompilieren, führen Sie Folgendes aus:

npm run build

Dadurch wird ein dist -Verzeichnis erstellt, das die kompilierten JavaScript-Dateien enthält.

Ausführen des Projekts

Nach dem Erstellen können Sie das Projekt mit Folgendem ausführen:

node dist/index.js

Oder verwenden Sie das npm-Skript:

npm start

Claude Desktop-Konfiguration

Lokaler Start vom Code

Um dieses Projekt mit Claude Desktop zu konfigurieren, fügen Sie Ihren Claude Desktop-Einstellungen die folgende Konfiguration hinzu:

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

Vom Docker-Image ausführen

{
  "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>"
      }
    }
  }
}

Von npx ausführen

{
  "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>"
      }
    }
  }
}

Verbindung über Remote-Server herstellen

{
  "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>"
      }
    }
  }
}

Stellen Sie sicher, dass Sie den Dateipfad im args -Array so anpassen, dass er mit Ihrem lokalen Projektverzeichnis übereinstimmt.

Entwicklung

So führen Sie das Projekt im Entwicklungsmodus mit automatischer Neukompilierung aus:

1. Installieren Sie ts-node und nodemon als Entwicklungsabhängigkeiten:

npm install --save-dev ts-node nodemon

2. Fügen Sie Ihrem package.json ein Entwicklungsskript hinzu:

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

3. Führen Sie den Entwicklungsserver aus:

npm run dev

Projektstruktur

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

Tools und Ressourcen

Der Mailmodo MCP-Server bietet verschiedene Tools und Ressourcen für die Interaktion mit den Funktionen von Mailmodo. Hier ist eine umfassende Liste:

Ressourcen

1. Mailmodo-Vorlagen ( mailmodo://templates )

   • Gibt eine Liste aller verfügbaren E-Mail-Vorlagen im JSON-Format zurück

   • MIME-Typ: application/json

2. Mailmodo-Kampagnen ( mailmodo://campaigns )

   • Gibt eine Liste aller Kampagnen im JSON-Format zurück

   • MIME-Typ: application/json

3. Mailmodo-Kontaktlisten ( mailmodo://contact-lists )

   • Gibt alle Kontaktlisten im JSON-Format zurück

   • MIME-Typ: application/json

Werkzeuge

1. Benutzerdetails

   • Name: userDetails

   • Beschreibung: Alle Details eines Kontakts abrufen

   • Parameter:

     • email (Zeichenfolge): E-Mail-Adresse des Kontakts

2. Kampagnenbericht-Tool

   • Name: MailmodoCampainReportTool

   • Beschreibung: Erhalten Sie Kampagnenberichte, einschließlich Öffnungs-, Klick- und Übermittlungszahlen

   • Parameter:

     • campaignId (UUID): ID der Kampagne

     • fromDate (JJJJ-MM-TT): Startdatum für den Bericht

     • toDate (JJJJ-MM-TT): Enddatum für den Bericht

3. Aktuelles Datum/Uhrzeit

   • Name: currentDateTime

   • Beschreibung: Aktuelles Datum und Uhrzeit abrufen

   • Parameter: Keine

4. Ereignis senden

   • Name: sendEvent

   • Beschreibung: Senden Sie benutzerdefinierte Ereignisse mit E-Mail- und Ereigniseigenschaften

   • Parameter:

     • email (Zeichenfolge): E-Mail-Adresse des Kontakts

     • event_name (Zeichenfolge): Name des Ereignisses

     • ts (Zahl, optional): Zeitstempel

     • event_properties (Objekt, optional): Zusätzliche Ereigniseigenschaften

5. Kontaktlistenverwaltung

   • Kontakt zur Liste hinzufügen

     • Name: addContactToList

     • Beschreibung: Einen einzelnen Kontakt zu einer Liste hinzufügen

     • Parameter:

       • email (Zeichenfolge): E-Mail des Kontakts

       • listName (Zeichenfolge): Name der Liste

       • data (Objekt, optional): Kontakteigenschaften

       • Verschiedene optionale Felder für Kontaktmetadaten

   • Massenhinzufügen von Kontakten

     • Name: addBulkContactToList

     • Beschreibung: Fügen Sie in einem einzigen Vorgang mehrere Kontakte zu einer Liste hinzu

     • Parameter:

       • listName (Zeichenfolge): Name der Liste

       • values (Array): Array von Kontaktobjekten

   • Kontakt aus der Liste entfernen

     • Name: removeContactFromList

     • Beschreibung: Entfernen Sie einen Kontakt aus einer bestimmten Liste

     • Parameter:

       • email (Zeichenfolge): E-Mail des Kontakts

       • listName (Zeichenfolge): Name der Liste

6. Kontaktstatusverwaltung

   • Abmelden Kontakt

     • Name: unsubscribeContact

     • Beschreibung: Einen Kontakt abbestellen oder unterdrücken

     • Parameter:

       • email (Zeichenfolge): E-Mail des Kontakts

   • Erneut abonnieren Kontakt

     • Name: resubscribeContact

     • Beschreibung: Einen zuvor abgemeldeten Kontakt erneut anmelden

     • Parameter:

       • email (Zeichenfolge): E-Mail des Kontakts

   • Archiv Kontakt

     • Name: archiveContact

     • Beschreibung: Einen Kontakt dauerhaft archivieren

     • Parameter:

       • email (Zeichenfolge): E-Mail des Kontakts

7. Kampagnenmanagement

   • E-Mail-Kampagne senden

     • Name: sendEmailToCampaign

     • Beschreibung: Eine E-Mail-Kampagne mit Personalisierung auslösen

     • Parameter:

       • campaignId (Zeichenfolge): Kampagnen-ID

       • email (Zeichenfolge): E-Mail des Empfängers

       • Verschiedene optionale Parameter zur individuellen Anpassung

   • Broadcast-Kampagne

     • Name: broadcastCampaignToList

     • Beschreibung: Kampagnen für eine ganze Kontaktliste auslösen

     • Parameter:

       • campaignId (Zeichenfolge): Kampagnen-ID

       • listId (Zeichenfolge): Ziellisten-ID

       • Optionale Parameter zur Kampagnenanpassung

Lizenz

MIT-Lizenz