Mailmodo

mailmodo-mcp

Это проект TypeScript, реализующий сервер протокола управления сообщениями (MCP) для интеграции Mailmodo с Claude Desktop и другими клиентами, поддерживающими MCP.

Предпосылки

• Node.js (рекомендуется v20 или выше)
• npm (входит в состав Node.js)

Установка

Установка через Smithery

Чтобы автоматически установить Mailmodo Integration Server для Claude Desktop через Smithery :

Ручная установка

1. Клонируйте репозиторий:

2. Установить зависимости:

Создание проекта

Чтобы скомпилировать код TypeScript в JavaScript, выполните:

Это создаст каталог dist , содержащий скомпилированные файлы JavaScript.

Реализация проекта

После сборки вы можете запустить проект с помощью:

Или используйте скрипт npm:

Конфигурация рабочего стола Клода

Локальный запуск из кода

Чтобы настроить этот проект с помощью Claude Desktop, добавьте следующую конфигурацию в настройки Claude Desktop:

Запустить из образа Docker

Запуск из npx

Подключиться через удаленный сервер

Обязательно измените путь к файлу в массиве args так, чтобы он соответствовал локальному каталогу проекта.

Разработка

Для запуска проекта в режиме разработки с автоматической перекомпиляцией:

1. Установите ts-node и nodemon как зависимости разработки:

2. Добавьте скрипт разработки в ваш package.json:

3. Запустите сервер разработки:

Структура проекта

Инструменты и ресурсы

Сервер Mailmodo MCP предоставляет несколько инструментов и ресурсов для взаимодействия с функционалом Mailmodo. Вот полный список:

Ресурсы

1. Шаблоны Mailmodo ( mailmodo://templates )
   • Возвращает список всех доступных шаблонов электронной почты в формате JSON.
   • Тип MIME: приложение/json
2. Кампании Mailmodo ( mailmodo://campaigns )
   • Возвращает список всех кампаний в формате JSON.
   • Тип MIME: приложение/json
3. Списки контактов Mailmodo ( mailmodo://contact-lists )
   • Возвращает все списки контактов в формате JSON
   • Тип MIME: приложение/json

Инструменты

1. Данные пользователя
   • Имя: userDetails
   • Описание: Получить все данные о контакте
   • Параметры:
     • email (строка): Адрес электронной почты контакта
2. Инструмент отчета кампании
   • Имя: MailmodoCampainReportTool
   • Описание: Получайте отчеты о кампаниях, включая количество открытий, кликов и отправок.
   • Параметры:
     • campaignId (UUID): идентификатор кампании
     • fromDate (ГГГГ-ММ-ДД): Начальная дата для отчета
     • toDate (ГГГГ-ММ-ДД): Конечная дата для отчета
3. Текущая дата и время
   • Имя: currentDateTime
   • Описание: Получить текущую дату и время
   • Параметры: Нет
4. Отправить событие
   • Имя: sendEvent
   • Описание: Отправка пользовательских событий с помощью электронной почты и свойств события.
   • Параметры:
     • email (строка): Адрес электронной почты контакта
     • event_name (строка): Название события
     • ts (число, необязательно): временная метка
     • event_properties (объект, необязательно): Дополнительные свойства события
5. Управление списком контактов
   • Добавить контакт в список
     • Имя: addContactToList
     • Описание: Добавить один контакт в список.
     • Параметры:
       • email (строка): Электронная почта контакта
       • listName (строка): Имя списка
       • data (объект, необязательно): Свойства контакта
       • Различные необязательные поля для метаданных контакта
   • Массовое добавление контактов
     • Имя: addBulkContactToList
     • Описание: Добавление нескольких контактов в список за одну операцию.
     • Параметры:
       • listName (строка): Имя списка
       • values (массив): Массив контактных объектов
   • Удалить контакт из списка
     • Имя: removeContactFromList
     • Описание: Удалить контакт из определенного списка.
     • Параметры:
       • email (строка): Электронная почта контакта
       • listName (строка): Имя списка
6. Управление статусом контакта
   • Отписаться Связаться
     • Имя: unsubscribeContact
     • Описание: Отменить подписку или скрыть контакт
     • Параметры:
       • email (строка): Электронная почта контакта
   • Подписаться повторно Связаться
     • Имя: resubscribeContact
     • Описание: Повторная подписка ранее отписанного контакта.
     • Параметры:
       • email (строка): Электронная почта контакта
   • Архив Контакты
     • Имя: archiveContact
     • Описание: Постоянное архивирование контакта.
     • Параметры:
       • email (строка): Электронная почта контакта
7. Управление кампанией
   • Отправить кампанию по электронной почте
     • Имя: sendEmailToCampaign
     • Описание: Запуск кампании по электронной почте с персонализацией
     • Параметры:
       • campaignId (строка): идентификатор кампании
       • email (строка): Электронная почта получателя
       • Различные дополнительные параметры для настройки
   • Трансляция кампании
     • Имя: broadcastCampaignToList
     • Описание: Запуск кампаний по всему списку контактов.
     • Параметры:
       • campaignId (строка): идентификатор кампании
       • listId (строка): Идентификатор целевого списка
       • Дополнительные параметры для настройки кампании

Лицензия

Лицензия Массачусетского технологического института