mailmodo-mcp

значок кузнеца

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

Предпосылки

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

Related MCP server: Liveblocks

Установка

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

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

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

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

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

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

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

npm install

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

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

npm run build

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

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

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

node dist/index.js

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

npm start

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

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

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

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

Запустить из образа 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>" } } } }

Запуск из 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>" } } } }

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

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

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

Разработка

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

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

npm install --save-dev ts-node nodemon

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

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

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

npm run dev

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

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

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

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

Ресурсы

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

Инструменты

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

Лицензия

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

Mailmodo