inxmail-mcp

npm version npm downloads License: MIT MCP Node.js Glama Awesome MCP Servers

MCP-сервер для Inxmail Commerce Transactional API. Управляйте событиями, отправками, возвратами, списком блокировок, черным списком, реакциями и отслеживанием доставки — напрямую из Claude.

Быстрый старт

1. Установка

npm install -g inxmail-mcp
# or use npx (no install needed)

2. Получение учетных данных API

В панели администратора Inxmail Commerce создайте ключ API в разделе API Login Data. Вы получите:

API Key ID (имя пользователя)
API Secret (пароль)

Имя вашего экземпляра (instance) — это поддомен из вашего URL API Inxmail Commerce:

https://your-instance.api.inxmail-commerce.com/ -> instance = your-instance

3. Настройка для Claude Code

claude mcp add inxmail-mcp -e INXMAIL_INSTANCE=your-instance -e INXMAIL_API_KEY_ID=your-key-id -e INXMAIL_API_SECRET=your-secret -- npx -y inxmail-mcp

Или из исходного кода:

claude mcp add inxmail-mcp -e INXMAIL_INSTANCE=your-instance -e INXMAIL_API_KEY_ID=your-key-id -e INXMAIL_API_SECRET=your-secret -- node /path/to/inxmail-mcp/build/index.js

4. Настройка для Claude Desktop

Добавьте в claude_desktop_config.json:

{
  "mcpServers": {
    "inxmail": {
      "command": "npx",
      "args": ["-y", "inxmail-mcp"],
      "env": {
        "INXMAIL_INSTANCE": "your-instance",
        "INXMAIL_API_KEY_ID": "your-key-id",
        "INXMAIL_API_SECRET": "your-secret"
      }
    }
  }
}

Доступные инструменты

Основные сценарии использования

Инструмент	Описание
`check_email_delivery`	Проверка статуса доставки письма — отправки, возвраты, реакции и статус блокировки
`check_email_blocked`	Проверка, заблокирован ли адрес электронной почты (hard bounces в списке блокировок + явные блокировки в черном списке)
`get_server_info`	Получение точки входа API со ссылками на все доступные ресурсы

События

Инструмент	Описание
`trigger_event`	Запуск события транзакционного письма
`get_event_state`	Получение состояния/результата запущенного события по ID транзакции
`list_event_types`	Список всех настроенных типов событий
`get_event_type`	Получение одного типа события по ID

Отправки

Инструмент	Описание
`list_sendings`	Список отправленных транзакционных писем с фильтрами
`get_sending`	Получение деталей конкретной отправки по ID

Реакции и отслеживание

Инструмент	Описание
`list_reactions`	Список реакций получателей (открытия и клики)
`list_deliveries`	Список информации о статусе доставки

Возвраты и жалобы

Инструмент	Описание
`list_bounces`	Список возвращенных транзакционных писем
`list_complaints`	Список жалоб через механизм обратной связи (feedback loop)

Список блокировок (Hard Bounces)

Инструмент	Описание
`list_blocklist`	Список адресов электронной почты, заблокированных из-за hard bounce
`get_blocklist_entry`	Проверка, находится ли конкретный адрес в списке блокировок
`remove_from_blocklist`	Удаление адреса из списка блокировок

Черный список (Явные блокировки)

Инструмент	Описание
`list_blacklist`	Список адресов электронной почты, явно добавленных в черный список
`get_blacklist_entry`	Проверка, находится ли конкретный адрес в черном списке
`add_to_blacklist`	Добавление адреса электронной почты в черный список
`remove_from_blacklist`	Удаление адреса из черного списка

Почтовый ретранслятор (Mail Relay)

Инструмент	Описание
`list_relay_sendings`	Список отправок через почтовый ретранслятор
`get_relay_sending`	Получение деталей конкретной отправки через ретранслятор
`list_relay_reactions`	Список реакций на письма через ретранслятор (открытия, клики)
`list_relay_bounces`	Список возвратов через ретранслятор
`list_relay_complaints`	Список жалоб через ретранслятор

Raw Mail

Инструмент	Описание
`send_raw_mail`	Отправка полноценного письма RFC 5322 (в кодировке Base64)

Журналы ошибок

Инструмент	Описание
`list_error_logs`	Список записей журнала ошибок
`get_error_log`	Получение одной записи журнала ошибок по ID
`mark_error_log_read`	Отметка записи журнала ошибок как прочитанной

Примеры запросов

"Is test@example.com blocked or blacklisted?"

"Check the delivery status for user@example.com"

"List all bounces from last week"

"Trigger a welcome email event for new-user@example.com"

"Show me all event types configured in the system"

"List recent complaints from the last 30 days"

Разработка

git clone https://github.com/shahabazdev/inxmail-mcp.git
cd inxmail-mcp
npm install
npm run build

Тестирование

npm test          # run all tests
npx vitest        # run in watch mode

Запускает модульные тесты с помощью Vitest, охватывающие:

Клиент API (авторизация, методы запросов, параметры запроса, пагинация, обработка ошибок)
Регистрацию инструментов (все 29 инструментов зарегистрированы, дубликатов нет)

Переменные окружения

Переменная	Обязательно	Описание
`INXMAIL_INSTANCE`	Да	Поддомен экземпляра (например, `your-instance`)
`INXMAIL_API_KEY_ID`	Да	ID ключа API
`INXMAIL_API_SECRET`	Да	Секрет API

Лицензия

MIT

Inxmail MCP