Skip to main content
Glama
campaign-preflight-mcp

campaign-preflight-mcp

by katekruger

Предполётная проверка кампании

Campaign Preflight — это линтер только для чтения для исходящих кампаний. Он выявляет проблемы с конфигурацией, контактными данными, персонализацией, подавлением, расписанием и отправителями до запуска.

CI Security Python 3.9+ Dependencies: none License: MIT


Что он делает

Каждая команда, занимающаяся исходящими рассылками, отправляла кампанию с ошибкой. Кто-то, кто отписался, всё равно получил письмо. Последовательность продолжала отправлять follow-up после того, как потенциальный клиент ответил. Merge-поле никогда не подставлялось, и двести человек получили «Привет {{first_name}}».

Вы узнаёте об этом после отправки.

Campaign Preflight выполняет 76 детерминированных проверок конфигурации кампании, лидов, текста, расписания, отправителей и подверженности подавлению, и возвращает решение о готовности с доказательствами для каждого вывода. Он никогда не записывает данные в ваш провайдер и не может ничего активировать.

Что он не делает, сразу, а не в конце:

  • Он не гарантирует доставляемость. Он проверяет конфигурацию и данные, а не попадание во входящие, и никогда не выдумывает оценку доставляемости.

  • Он не даёт юридических консультаций. Проверки региона, домена и отказа от подписки сравнивают кампанию с вашей собственной настроенной политикой — а не с GDPR, CAN-SPAM или CASL.

  • Он не проверяет почтовые ящики. Проверки адресов — только синтаксические. Никакого DNS, никакого SMTP.

  • Он не заменяет защитные механизмы вашего провайдера. Оставьте их включёнными.

  • Результаты — это снимок на конкретный момент времени. Кампания, прошедшая проверку в 09:00, может быть отредактирована в 09:05.

Более подробно в docs/limitations.md.


Related MCP server: checkyourself

«Мы проверили, и всё в порядке» ≠ «мы не смогли проверить»

Проверяющий инструмент, который не может отличить эти случаи, хуже, чем отсутствие проверки, потому что он превращает ошибку прав доступа в зелёный свет.

Campaign Preflight делает это различие структурным. Каждое чтение от провайдера возвращает данные плюс причину, по которой они существуют или не существуют, и каждое правило объявляет, какие данные ему нужны. Если эти данные недоступны, движок переводит правило в состояние UNKNOWN до того, как оно сможет выполниться. Правила не могут отказаться от этого.

Ситуация

Результат

Список подавления прочитан, никто не совпал

PASS

Список подавления не предоставлен

UNKNOWN → запуск INCOMPLETE

Конечная точка подавления вернула 403

UNKNOWN → запуск INCOMPLETE

Ноль лидов в кампании

FAIL

Конечная точка лидов недоступна

UNKNOWN

Есть четыре вердикта, а не два: READY, READY_WITH_WARNINGS, NOT_READY и INCOMPLETE.


Требования

Python 3.9 или новее. Это весь список.

У пакета нет зависимостей времени выполнения — он не импортирует ничего за пределами стандартной библиотеки. httpx — это опциональное дополнение, необходимое только для живого провайдера Instantly, за ленивым импортом.

Минимальная версия 3.9 выбрана намеренно и намеренно ниже, чем можно было бы ожидать. Это самый старый интерпретатор, который плагин может встретить на машине пользователя, и поскольку зависимостей нет, ничто не заставляет его быть выше. CI запускает 3.9–3.13 плюс задание с «голым» интерпретатором, которое вообще ничего не устанавливает, на Linux, macOS и Windows.

Именно эта комбинация позволяет плагину работать без этапа установки: он использует тот python3, который уже есть.


Установка

Как плагин Claude (маркетплейс)

/plugin marketplace add katekruger/campaignpreflightplugin
/plugin install campaign-preflight

Репозиторий сам по себе является маркетплейсом: .claude-plugin/marketplace.json находится в корне рядом с манифестом плагина.

Как плагин Claude (локальная копия)

git clone https://github.com/katekruger/campaignpreflightplugin
/plugin marketplace add ./campaignpreflightplugin
/plugin install campaign-preflight

Как CLI

pipx install campaign-preflight

Или прямо из копии репозитория, вообще ничего не устанавливая:

PYTHONPATH=src python3 -m campaign_preflight.cli demo

Как MCP-сервер

claude mcp add campaign-preflight -- campaign-preflight-mcp

Шесть инструментов только для чтения. Ничего, что могло бы активировать, редактировать, импортировать или отправлять. Настройка для Claude Code и Claude Desktop: docs/mcp.md.


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

campaign-preflight demo

Никакого API-ключа. Никакой сети. Никакой конфигурации.

CAMPAIGN PREFLIGHT
Campaign: Enterprise Q3 Outbound
Provider: demo
Readiness: NOT READY
Score: 0/100
Confidence: MEDIUM

BLOCKERS

[campaign.stop_on_reply]
Stop-on-reply is disabled: repliers will keep receiving follow-ups.
  Remediation: Enable stop-on-reply on the campaign.

[personalization.prompt_injection]
1 contact(s) have prompt-injection text in their personalization.
  Affected: s***********a@caldera.example.com
  Remediation: Remove the affected personalization and review the enrichment source it came from.

[suppression.contact_listed]
1 contact(s) appear on the active suppression list.
  Affected: m**********s@stonebridge.example.com
  Remediation: Remove these contacts from the campaign before activation.

WARNINGS

[contacts.missing_first_name]
2 of 20 contacts (10.0%) are missing a first name.
  Affected: i**o@summitforge.example.com, r******s@clearwater.example.com
  Remediation: Backfill the missing first names, or use a fallback in your copy.

UNKNOWN

[senders.aggregate_capacity]
Sender capacity is unavailable: 1 of 3 senders report no daily limit.
  Affected: r***n@example.com

------------------------------------------------------------------------------
Summary:
8 blockers, 17 failures, 21 warnings, 1 unknown, 32 passed
20 leads and 3 sender(s) checked in 0.0s
Confidence is MEDIUM: 1 check(s) could not run.
Point-in-time snapshot. Campaign state may change after this check ran.

Обратите внимание на последний вывод. Один отправитель не сообщает дневной лимит, поэтому общую ёмкость невозможно суммировать. Большинство инструментов сложили бы отправителей, у которых лимит есть, и назвали бы это числом. Этот говорит, что не знает — и из-за этого снижает уверенность с HIGH до MEDIUM.

Это различие и есть вся идея.

Проверка собственной кампании

После установки плагина опишите её простым языком:

Проверь эту кампанию перед отправкой.

Вот мой список лидов — что с ним не так? (вставьте или загрузите)

Я отправляю последовательность из 3 писем 200 людям, по 80 в день, в будни с 9 до 17 по восточному времени. Это нормально?

Есть три способа начать, и ни один не требует учётной записи:

У вас есть

Что происходит

Файл (загруженный или на диске)

Проверяется напрямую.

Вставленный список или текст

Записывается во временный файл, проверяется, затем удаляется.

Только описание

Файл кампании создаётся из ваших слов, показывается вам, затем проверяется.

Всё, что вы не знаете, остаётся пустым, а не угадывается — пустое поле возвращается как «не удалось проверить», что является честным ответом.

Из файлов, в командной строке

campaign-preflight check \
  --campaign examples/clean_campaign/campaign.yaml \
  --leads examples/clean_campaign/leads.csv \
  --suppressions examples/clean_campaign/suppressions.csv

В репозитории есть три рабочих примера, по одному на каждый вердикт:

Пример

Вердикт

Код выхода

examples/clean_campaign

READY, 100/100

0

examples/risky_campaign

NOT_READY, 13 блокирующих проблем

2

examples/incomplete_campaign

INCOMPLETE — ничего не неправильно, просто невозможно проверить

3

В CI

campaign-preflight check --campaign campaign.yaml --leads leads.csv --fail-on blocker

Коды выхода несут вердикт, так что это напрямую встраивается в конвейер. См. docs/ci.md.


Что внутри

Корень репозитория и есть плагин. Нет второй копии дерева.

.claude-plugin/     plugin manifest and marketplace manifest
skills/             the three skills, one directory each
bin/                launchers the MCP server and CLI run through
src/                the Python package: rules, engine, providers, reporters
tests/              unit, integration, contract
docs/               rules catalogue, configuration, MCP, CI, limitations, architecture
examples/           three worked campaigns, one per verdict
scripts/            generators and the plugin packager

Навыки

Навык

Для чего использовать

preflight-campaign

Проверка реальной кампании, которую вы предоставляете — файл, вставленный текст или описание.

preflight-demo

Наблюдение за работой проверщика на встроенных примерах данных.

preflight-rules

Какие правила существуют, что каждое проверяет и как их перенастроить или отключить.

Границы намеренны: каждое описание называет свою собственную ситуацию и указывает на соседнее, так что почти-попадание попадает в восстанавливаемое место.


Что он проверяет

76 правил в семи категориях. Полный каталог: docs/rules.md.

Категория

Правил

Примеры

Кампания

10

Отключён stop-on-reply, дневной объём выше порога, нет окна отправки, даты, не оставляющие дней для отправки

Контакты

15

Некорректные адреса, дубликаты (точные и с учётом регистра), ролевые ящики, значения-заглушки, управляющие и двунаправленные символы, инъекция формул в электронные таблицы

Подавление

8

Контакты и домены в вашем списке подавления, существующие клиенты, внутренние адреса, конкуренты, ограниченные регионы — и могла ли проверка подавления вообще выполниться

Персонализация

13

Необработанные merge-токены, приветствие, адресованное не тому человеку, компания, которая не их, утверждения, не подтверждённые их собственными доказательствами, устаревшие исследования, текст с prompt-инъекцией, соскобленный со страницы цели

Текст

13

Пустая тема на первом шаге, битые ссылки, маркеры TODO, отсутствующий язык отказа от подписки, follow-up, идентичный первому письму

Расписание

9

Неверный часовой пояс, отправка в выходные, ноль активных дней, окно, которое заканчивается раньше, чем начинается, переходы на летнее время внутри кампании

Отправители

8

Почтовые ящики ниже вашего порога здоровья, состояния ошибок, объём, превышающий ёмкость — и честные UNKNOWN, когда провайдер не сообщает

Спросите инструмент о любом из них:

campaign-preflight rules list --category suppression
campaign-preflight rules explain senders.aggregate_capacity

Что он намеренно не проверяет

Нет правила о спам-словах. «Бесплатно» и «действуйте сейчас» не являются доказательством чего-либо, и наличие такого списка приучило бы вас игнорировать инструмент. Правила, которые являются оценочными суждениями — длина текста, количество ссылок, артефакты генерации — помечены как heuristic, обозначены таковыми в каждом отчёте и по умолчанию никогда не являются блокирующими.


Конфигурация

Campaign Preflight работает с разумными настройками по умолчанию и без файла конфигурации. Добавьте его, когда ваши пороги отличаются, или чтобы включить проверки, зависящие от ваших собственных списков доменов и регионов.

version: 1

settings:
  target_timezone: America/New_York
  required_variables: [first_name, company_name]
  internal_domains: [ourcompany.example.com]
  customer_domains: [bigcustomer.example.com]
  allow_weekend_sending: false

rules:
  campaign.daily_volume:
    warning_above: 100
    blocker_above: 250
  senders.health_below_threshold:
    minimum_score: 80
  contacts.missing_job_title:
    enabled: false
campaign-preflight validate-config preflight.yaml
campaign-preflight check --campaign c.yaml --leads l.csv --config preflight.yaml

Проверка намеренно строгая: неизвестный идентификатор правила или неизвестная опция — это жёсткая ошибка, а не предупреждение. Опечатка, которая молча отключает проверку безопасности, хуже, чем отсутствие конфигурации вообще.

Полный справочник: docs/configuration.md.


Почему режим только для чтения важен

В Campaign Preflight нет пути кода, который записывает. Не «мы решили не делать» — вызывать нечего.

  • Провайдер Instantly направляет каждый запрос через транспорт, который проверяет (method, path) по явному списку разрешений и вызывает исключение до того, как запрос покинет процесс. Проверка находится ниже клиента и ниже провайдера, поэтому будущее изменение кода, добавляющее PATCH, завершится с ошибкой, а не молча отредактирует вашу кампанию.

  • Две проверки выполняются при импорте: список разрешений не может содержать PUT, PATCH, DELETE, HEAD или OPTIONS, а POST разрешён ровно для одного пути (/leads/list, что является документированной формой Instantly для фильтрованного чтения).

  • MCP-сервер отказывается запускаться, если у любого зарегистрированного инструмента есть изменяющий глагол в имени или он не объявляет себя доступным только для чтения.

  • tests/contract/test_instantly_transport.py проверяет полную матрицу метод × путь плюс каждую документированную изменяющую конечную точку. Сбой там — это инцидент безопасности, а не сбой теста.

Именно поэтому безопасно передавать агенту живую кампанию. Он получает анализ и никаких полномочий.

Что он никогда не будет делать

  • Активировать, приостановить, возобновить или запланировать кампанию

  • Создать, обновить, переместить, объединить или удалить лид

  • Добавить в список подавления или удалить из него

  • Отправить, ответить или переслать письмо

  • Изменить что-либо в вашей платформе отправки

Не существует пути кода ни к одному из этих действий, и два независимых предохранителя — транспортный белый список и проверка запуска MCP — закрываются по умолчанию, если такое действие когда-либо будет добавлено.


Коды выхода

Code

Meaning

0

READY

1

READY_WITH_WARNINGS

2

NOT_READY

3

INCOMPLETE — критическая проверка не смогла выполниться

4

Ошибка конфигурации или входных данных

5

Ошибка провайдера или аутентификации

6

Непредвиденная внутренняя ошибка

--fail-on none|warning|high|blocker повышает порог, при котором вердикт приводит к ненулевому коду выхода. Он никогда не меняет сам вердикт. INCOMPLETE не подавляется порогом серьёзности — проверка, которая не смогла выполниться, это иная проблема, чем находка низкой серьёзности.


Оценка публикуется, а не скрывается

score = 100 - sum(weight[status][severity] for every FAIL and WARN)

readiness:
  NOT_READY            any BLOCKER FAIL, or any HIGH FAIL
  INCOMPLETE           else if any critical rule is UNKNOWN
  READY_WITH_WARNINGS  else if any FAIL or WARN
  READY                otherwise

Из этого следует четыре вещи, и для каждой есть тест:

  1. Блокирующая проблема всегда даёт NOT_READY. Число не может переопределить это.

  2. UNKNOWN ничего не вычитает. Сбой провайдера не должен выглядеть как плохая кампания — он снижает уверенность.

  3. NOT_APPLICABLE ни на что не влияет.

  4. Каждое вычитание детализировано. --verbose выводит арифметику, чтобы вы могли проверить её вручную.

Веса и список критических правил настраиваются: docs/configuration.md.


Архитектура

flowchart LR
    CLI[CLI] --> Engine
    MCP[MCP server] --> Engine
    Engine -->|gather| Provider{Provider}
    Provider --> CSV[CSV / files]
    Provider --> Instantly[Instantly v2]
    Instantly --> Guard[ReadOnlyTransport]
    Guard -->|allowlist| API[(Instantly API)]
    Provider -->|data + why| Context[Frozen context]
    Context --> Rules[76 rules]
    Rules --> Score[Scoring]
    Score --> Out[Terminal / JSON / Markdown]
    style Guard fill:#4a1f1f,stroke:#c04040,color:#fff

Контекст — это замороженная модель Pydantic, поэтому «правило никогда не изменяет свои входные данные» обеспечивается системой типов, а не ревью. Поведение, специфичное для провайдера, полностью скрыто за интерфейсом провайдера.

Полный дизайн и модель угроз: docs/architecture.md.


Конфиденциальность

  • Редактируется по умолчанию. Локальные части почтовых ящиков маскируются (m**********s@stonebridge.example.com); домены сохраняются, потому что домен — это то, что делает находку о подавлении применимой.

  • Секреты безусловно вычищаются. --no-redact отключает маскирование PII, но никогда не маскирование учётных данных. Провайдер, который возвращает ваш API-ключ в теле ошибки, не сможет протащить его в отчёт — для этого есть тест.

  • По умолчанию ничего не покидает вашу машину. Опциональный оценщик утверждений LLM выключен, пока вы его не настроите, а validate-config предупреждает вас, когда конфигурация его включает.

  • Файлы отчётов записываются с правами 0600, во временный файл, а затем переименовываются.

  • Выборки ограничены. Кампания на 100 000 лидов не может выдать 100 000 строк.


Производительность

Нагрузка

Время

Демо (20 лидов)

0.02 s

10 000 лидов

0.28 s

100 000 лидов

3.0 s, пик ~300 МБ

Строки передаются потоком, а не загружаются целиком. Пагинация, повторы, конкурентность отправителя и размер вывода ограничены.


Разработка

git clone https://github.com/katekruger/campaignpreflightplugin
cd campaignpreflightplugin
uv sync --all-extras
uv run pytest
uv run ruff format .                                  # format
uv run ruff check .                                   # lint
uv run mypy                                           # typecheck, strict
claude plugin validate . --strict                     # manifests
uv run python scripts/generate_rules_doc.py --check   # docs/rules.md is current
./scripts/bump-version.sh --check                     # version fields agree
uv run python scripts/build_plugin.py                 # dist/campaign-preflight.plugin

Сам пакет не имеет зависимостей времени выполнения; группа dev существует для тестового набора, линтеров и двух библиотек, используемых только как тестовые оракулы — httpx для опционального провайдера Instantly и PyYAML для дифференциального тестирования встроенного YAML-парсера.

Соглашения, которые выглядят как ошибки, пока не узнаешь причину, описаны в CLAUDE.md.


Дорожная карта

  • Дополнительные провайдеры за тем же интерфейсом только для чтения (Smartlead, HubSpot Sequences, Apollo)

  • Проверки репутации домена и DNS-записей (SPF, DKIM, DMARC alignment)

  • GitHub Action, оборачивающий CLI с аннотациями в PR

  • Сравнение с базовым уровнем: сравнение двух отчётов и показ изменений с прошлого запуска

  • Пороги для каждого сегмента, чтобы один конфиг мог покрывать несколько сценариев

Участие

Правила небольшие, чистые и независимо тестируемые — новое правило обычно представляет собой класс, docstring и несколько тестов. См. CONTRIBUTING.md и CODE_OF_CONDUCT.md.

Безопасность

Сообщайте об уязвимостях конфиденциально: SECURITY.md. Правило, которое вернуло PASS при отсутствии данных, считается проблемой безопасности.

Лицензия

MIT. См. LICENSE.

Available Tools

6 tools
explain_preflight_ruleB
Read-onlyIdempotent

READ-ONLY. Explain one rule: what it checks, what data it needs, and its configurable options.

NameRequiredDescriptionDefault
rule_idYese.g. campaign.daily_volume

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered by structured data. The description's 'READ-ONLY' prefix reinforces but does not add to this. It adds minimal behavioral context beyond confirming the rule-explanation output, and does not contradict the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence with zero waste. The 'READ-ONLY' prefix overlaps with annotations but is harmless. Appropriately sized for a simple single-parameter tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a low-complexity tool (1 parameter, no output schema, no nesting), the description is reasonably complete — it states what the returned explanation covers. It partially compensates for the missing output schema by describing the explanation's contents, though it doesn't address error behavior for an invalid rule_id. Adequate given the tool's simplicity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% — rule_id is documented with an example ('campaign.daily_volume'). The description adds no parameter-level meaning beyond implying that rule_id selects the rule to explain, which the schema already conveys. Baseline 3 is appropriate since the schema carries the parameter burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Explain') and resource ('one rule'), and clarifies what the explanation covers (checks, data needs, configurable options). It implicitly distinguishes from siblings like list_preflight_rules and validate_preflight_config, though it does not name them explicitly. A clear, well-scoped purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is given on when to use this tool versus its siblings. The description does not state that this should be used when detailed information about a single rule is needed as opposed to list_preflight_rules for enumeration or validate_preflight_config for config checking. No exclusions or alternative routing provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_preflight_rulesA
Read-onlyIdempotent

READ-ONLY. List the preflight rule catalogue, optionally filtered by category: campaign, contacts, suppression, personalization, copy, schedule, or senders.

NameRequiredDescriptionDefault
categoryNo

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, and the description's opening 'READ-ONLY' merely reinforces that. It adds no deeper behavioral detail beyond the filter (which is more parameter-related). No mention of pagination, output format, or rate limits, but for a simple read-only list tool, the annotations carry the transparency burden sufficiently.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence that front-loads the read-only nature and the core action ('List'), followed by the only parameter detail. Every word earns its place; there is no redundancy or filler. Ideal conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with one optional enum parameter, no output schema, and no nested objects, the description covers the purpose, the filter, and its optionality. It does not mention return format or relationships to sibling tools, but those are not critical for a simple listing operation. The description is sufficiently complete for an agent to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage and only one optional enum parameter. The description explicitly lists all valid category values (campaign, contacts, suppression, personalization, copy, schedule, senders) and clarifies the parameter is optional ('optionally filtered'). This fully compensates for the schema's lack of descriptions, giving the agent complete knowledge of the parameter without opening the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('List') and resource ('preflight rule catalogue'), and mentions optional filtering. The purpose is clear and not a tautology. It does not explicitly distinguish from siblings like preflight_demo or preflight_files, but the name and description make the function obvious enough that an agent could differentiate it.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives context on the optional 'category' filter and lists valid categories, implying when filtering might be useful. However, it provides no explicit guidance on when to use this tool versus alternatives, nor any when-not-to-use statements. The presence of sibling tools like 'validate_preflight_config' suggests related actions, but no comparison is made.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

preflight_demoA
Read-onlyIdempotent

READ-ONLY. Run the bundled synthetic demo campaign and return its readiness report. Uses synthetic data shipped with the package: no network calls and no credentials. Useful for showing what a report looks like.

NameRequiredDescriptionDefault
max_samplesNoAffected records shown per finding.

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark readOnlyHint=true, destructiveHint=false, and idempotentHint=true, so the description's 'READ-ONLY' is redundant. However, it adds value by stating no network calls and no credentials, and that it uses synthetic data shipped with the package—behavioral details not present in annotations. No contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three short sentences, each earning its place: the first states the action and safety profile, the second gives key behavioral context, and the third explains practical utility. It is front-loaded with READ-ONLY and has no fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple demo tool with one optional parameter and no required inputs, the description fully covers what the agent needs: what it does, that it's safe (read-only, no network/credentials), and when it's useful (showing a report). No output schema exists, but the description doesn't need to detail report structure for a demo. Complete for its purpose.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%—the parameter max_samples is described as 'Affected records shown per finding.' The tool description does not mention the parameter at all, but since the schema fully covers it, the baseline of 3 applies. No additional semantic value added beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool runs a bundled synthetic demo campaign and returns a readiness report. The word 'demo' and 'synthetic' distinguish it from siblings like preflight_files or preflight_instantly_campaign, which likely operate on real data. This is a specific verb+resource with clear differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly notes it's 'useful for showing what a report looks like,' providing a direct use case. It also hints at no network calls and no credentials, implying it's safe for testing. However, it doesn't explicitly state when to prefer this over siblings, so it lacks explicit exclusions or alternative comparisons.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

preflight_filesA
Read-onlyIdempotent

READ-ONLY. Check a campaign described by local files and return its readiness report. Reads only the paths given here; no directory is scanned or walked. Optional inputs that are omitted are reported as unavailable capabilities, so a run without suppressions_path says the suppression checks did not run rather than implying the list is clean.

NameRequiredDescriptionDefault
leads_pathYesAbsolute or relative path to an existing file.
config_pathNoAbsolute or relative path to an existing file.
max_samplesNoAffected records shown per finding.
senders_pathNoAbsolute or relative path to an existing file.
campaign_pathYesAbsolute or relative path to an existing file.
evidence_pathNoAbsolute or relative path to an existing file.
output_formatNoShape of the returned report.
suppressions_pathNoAbsolute or relative path to an existing file.

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnly and idempotent annotations, the description adds critical behavioral context: it explicitly states that no directory scanning occurs and that omitted optional inputs are reported as 'unavailable capabilities' rather than clean results. This clarifies how the tool handles missing parameters, which is a significant behavioral nuance beyond the annotations alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three sentences with no filler. The first sentence states purpose, the second clarifies input scope, and the third explains behavior on omission. It is front-loaded with the core action and each sentence earns its place by contributing distinct, necessary information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 8 parameters, no output schema, and no explicit enumeration of the checks performed, the description provides sufficient context: it defines the tool's domain (local files), its safety profile, and handling of missing inputs. The output_format parameter handles return shape, and sibling tools list_preflight_rules/explain_preflight_rule can cover rule details. It is complete enough for an agent to use correctly, though slightly more detail on what 'readiness' entails would elevate it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already provides descriptions for all 8 parameters (100% coverage), so the baseline is 3. The description adds meaning by explaining the collective effect of omitting optional parameters (e.g., suppressions_path yields 'suppression checks did not run'), which is a parameter-level semantic not present in the schema. This justifies a 4 over the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action ('Check a campaign described by local files and return its readiness report') with a clear resource (local files). It distinguishes itself from siblings by emphasizing 'local files' and the scoping rule 'Reads only the paths given here', which sets it apart from tools like preflight_demo or preflight_instantly_campaign that likely handle other sources.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for file-based campaigns and clarifies that only explicit paths are read, but it does not explicitly contrast with sibling tools or state when to choose this over preflight_instantly_campaign or preflight_demo. The guidance is implied rather than directive, so it misses the 'when/when-not' bar for a higher score.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

preflight_instantly_campaignA
Read-onlyIdempotent

READ-ONLY. Inspect a live Instantly campaign and return its readiness report. Reads the campaign, its leads, its sending accounts, and the workspace block list. Every request is checked against a read-only allowlist before it leaves the process, so no write, activation, or lead-mutation call is reachable. The API key is read from the INSTANTLY_API_KEY environment variable and is never accepted as a tool argument.

NameRequiredDescriptionDefault
lead_limitNo
campaign_idYesInstantly campaign UUID.
config_pathNoAbsolute or relative path to an existing file.
max_samplesNoAffected records shown per finding.

TDQS

A4.2/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, but the description adds valuable context: every request is checked against a read-only allowlist, and the API key is sourced from INSTANTLY_API_KEY rather than a tool argument. This discloses operational safeguards and security details beyond the annotations, enhancing the agent's understanding of constraints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise at three sentences, with purpose front-loaded ('READ-ONLY. Inspect...'). However, there is slight redundancy: 'READ-ONLY' is repeated in the allowlist explanation. Despite this, the structure is efficient and each sentence adds relevant information—purpose, scope, and security mechanism.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with no output schema, the description should explain what the readiness report contains, but it only says 'readiness report' without detailing its format or contents. It does mention the data sources (leads, accounts, block list) but not the report's structure. Given the absence of output schema, this is a notable gap. The description covers the operational context well (read-only, API key), but the return value remains underspecified.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 75% (campaign_id, config_path, max_samples have descriptions; lead_limit has only min/max). The tool description does not elaborate on any parameter semantics. Per the rubric, with high schema coverage, a baseline of 3 is appropriate. The lack of compensation for the undocumented lead_limit is a minor gap, but overall the schema carries most of the parameter information.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's action and target: 'Inspect a live Instantly campaign and return its readiness report.' This is a specific verb-resource combination and explicitly distinguishes it from sibling tools (preflight_demo, preflight_files, list_preflight_rules, etc.) by the 'live Instantly campaign' scope. The mention of reading leads, sending accounts, and block list further clarifies the exact domain.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains the scenario (inspecting a live campaign) and the read-only nature, but does not explicitly compare with alternatives or state when not to use it. It provides clear context for when this tool is appropriate (live campaign inspection) without listing excluded cases or directing to other preflight tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

validate_preflight_configA
Read-onlyIdempotent

READ-ONLY. Validate a rules configuration file without running any checks. Reports unknown rule ids, unknown options, and out-of-range values.

NameRequiredDescriptionDefault
config_pathYesAbsolute or relative path to an existing file.

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already carry the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false), and the leading 'READ-ONLY' merely restates readOnlyHint. The added value is the description of what validation reports (unknown rule ids, unknown options, out-of-range values), which is useful but modest. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with no filler. The critical READ-ONLY safety flag is front-loaded, and the second sentence efficiently enumerates what the validation surfaces (unknown rule ids, options, out-of-range values). Slightly redundant with annotations but well-structured and brief.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter, read-only validation tool, this is nearly complete: purpose, scope, safety, and output dimensions are all covered. No output schema exists, but the description names the three classes of findings an agent can expect, which is sufficient for a config-validator of this simplicity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%; the schema already documents config_path as an absolute or relative path to an existing file. The description adds only the contextual hint that the path points to a configuration file, which aligns with but does not materially extend the schema. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Describes a specific verb (validate) applied to a specific resource (rules configuration file). It distinguishes itself from sibling tools like preflight_demo, preflight_files, and preflight_instantly_campaign by explicitly stating it does not run checks, and from list_preflight_rules/explain_preflight_rule by focusing on config validation rather than rule discovery. An agent can pick it apart from siblings without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides a clear context: validate a configuration file before executing checks. The phrase 'without running any checks' implicitly marks off the preflight_* siblings that do execute campaigns, giving a when-not signal. It does not name alternatives explicitly or give exclusion conditions, so it falls short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 6 tool updatesv0.1.0
    • First observedexplain_preflight_rule
    • First observedlist_preflight_rules
    • First observedpreflight_demo
    • First observedpreflight_files
    • First observedpreflight_instantly_campaign
    • First observedvalidate_preflight_config

TDQS

A3.9/5.0

Scored across 6 tools

Disambiguation5/5

Each tool serves a clearly distinct purpose: three preflight runners for different input sources (demo, files, live), two for rule management (list and explain), and one for config validation. There is no overlap in their operations, and the descriptions make it obvious which to select.

Naming Consistency4/5

Names use a consistent 'preflight_' prefix across all tools, but the pattern is not fully uniform: the first three are verbs implied by the domain (e.g., 'preflight_demo' runs a demo), while the last three explicitly start with verbs ('list_', 'explain_', 'validate_'). This is a minor deviation that agents can easily adapt to.

Tool Count5/5

With six tools, the server is well-scoped and avoids unnecessary bloat. Each tool covers a distinct aspect of the preflight workflow—execution sources, rule catalog, and configuration—so the count feels appropriately sized for the domain.

Completeness4/5

The surface covers the core lifecycle: running preflights on demo, files, or a live Instantly campaign; inspecting and understanding rules; and validating config files. A minor gap is the lack of a tool to run preflight on a manually specified set of parameters or a generic input, but the provided sources handle common use cases adequately.

Maintenance

ActivityStale
ResponsivenessSyncing

Related MCP Connectors

Related MCP Servers

  • A
    license
    B
    quality
    D
    maintenance
    A Model Context Protocol server that provides read-only access to Mailchimp's Marketing API for comprehensive email marketing data retrieval.
    38
    85 npm
    12
    MIT
  • F
    license
    Not graded
    quality
    C
    maintenance
    Read-only MCP server that performs deterministic local preflights of agent-payment boundary documents and x402 v2 PaymentRequired JSON, and prepares unsubmitted public quote-request drafts without network calls or fund movement.
    1
    -
  • A
    license
    A
    quality
    A
    maintenance
    A read-only MCP server that reports BI pipeline readiness, blockers, and the next allowed action for governed Power BI workflows. It never writes files, executes warehouse work, or grants human approvals.
    6
    10 npm
    2
    Apache 2.0