Skip to main content
Glama

@payretailers/mcp

Официальный сервер Model Context Protocol (MCP) для PayRetailers Payments API.

Превратите любого MCP-совместимого ИИ-ассистента в эксперта по интеграции с PayRetailers. Этот сервер предоставляет официальные руководства, тактические навыки, справочник по конечным точкам и инструменты интеграции (поиск, валидация для конкретных стран, плейбук вебхуков) как первоклассные MCP-ресурсы, инструменты и промпты.

Работает с Cursor, Claude Desktop, Claude Code, Windsurf, Antigravity, Zed, VS Code + Copilot, JetBrains IDEs, Continue.dev, Cline и любым другим клиентом, поддерживающим MCP через stdio.


Зачем это использовать

Когда вы устанавливаете этот сервер, ваш ИИ-ассистент перестаёт гадать о PayRetailers и начинает обращаться к первоисточнику на каждом шаге.

  • Правильный код с первой попытки. Ассистент читает реальную структуру OpenAPI для каждой конечной точки (get_endpoint_spec), поэтому сгенерированный код использует фактические имена полей, типы и обязательные комбинации — а не что-то заимствованное из другого PSP.

  • С учётом страны с самого начала. Спросите о PIX-платеже — и ассистент знает, что PIX доступен только в Бразилии, ожидает BRL, требует действительный 11-значный CPF, и что QR-код быстро истекает. Спросите о SPEI — и он знает, что Мексике нужен CURP или RFC, MXN, и что CLABE предоставляется асинхронно. Всё это обеспечивается через get_country_rules.

  • Полезные нагрузки проверяются до попадания в песочницу. validate_payload выполняет реальную проверку контрольных сумм для CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE — плюс сквозные правила (целые младшие единицы, HTTPS-URL уведомлений, соответствие валюты и страны, совместимость метода и страны, ключи идемпотентности, матрица обязательных полей клиента, форма AmountModel для подписок, контракт повторных попыток PIX Automático). Вы ловите ошибки в редакторе, а не в ответе 400 INVALID_MODEL_SCHEMA.

  • Правильно спроектированные приёмники вебхуков. get_webhook_playbook возвращает канонический словарь событий, политики повторных попыток и контракт подписи/воспроизведения. validate_webhook_handler выявляет шесть самых разрушительных анти-паттернов (подтверждение после обработки, отсутствие дедупликации по eventId, бизнес-ошибки как 500, отключённая подпись в продакшене, предположения о порядке по времени, отсутствие HTTPS) до того, как вы напишете хотя бы строку кода приёмника.

  • Слэш-команды для сложных сценариев. Введите /integrate-pix-payin, /integrate-subscriptions, /implement-webhook-handler, /integrate-payout-fx, /build-checkout, /debug-401-auth или /reconcile-with-graphql — и получите реализацию, готовую к продакшену, в выбранном вами стеке.

  • Ноль конфигурации, ноль сети, работает офлайн. Всё поставляется в составе релизного zip-архива. Никакого аккаунта, API-ключа или исходящих вызовов, чтобы просто ответить на вопрос о документации. Учётные данные нужны только для (планируемого) инструмента simulate_transaction.

Под капотом у вас 7 инструментов, 7 промптов, 158 документационных ресурсов (руководства + навыки + справочник + рецепты + концептуальные документы), все зеркально скопированы из репозитория payretailers-ai-docs.


Related MCP server: Payments Developer Portal MCP Server

Что он предоставляет

Ресурсы

Структурированный, удобный для LLM доступ к документации PayRetailers.

Шаблон URI

Что возвращает

payretailers://guide/{slug}

Полное руководство по интеграции с архитектурой, диаграммами последовательности, шагами реализации и чек-листом для продакшена.

payretailers://skill/{slug}

Ориентированный на задачу рабочий процесс, объединяющий несколько конечных точек (например, brazil-pix-payin, payout-fx-quote-flow).

payretailers://reference/{slug}

Отдельная страница справочника API (параметры, ответ, коды ошибок).

payretailers://recipe/{slug}

Короткий рецепт кода для типовой операции.

payretailers://doc/{slug}

Страница концепции/документации (subscription-concepts, webhooks-and-notifications, retry-policies, automatic-scheduling, clabe-per-customer, ...).

Полный список объявляется динамически при подключении — клиенты могут просматривать его через свой выбор ресурсов.

Инструменты

Действия, которые LLM может вызывать вместо предположений.

Инструмент

Что делает

Фаза

search_docs

Полнотекстовый поиск по руководствам, навыкам, справочнику, рецептам и концептуальным документам с нечётким сопоставлением и усилением полей заголовка/слага.

✅ 0.1

get_country_rules

Возвращает поля клиента, формат personalId (CPF, DNI, CURP, CC, RUT, ...), валюты и ограничения по способам оплаты для страны + метода.

✅ 0.2

get_test_data

Возвращает тестовые данные песочницы (клиенты, карты, ключи PIX, ключи Bre-B) для заданной страны.

✅ 0.2

get_endpoint_spec

Возвращает полную страницу справочника (параметры, ответ, коды ошибок) для конкретной конечной точки по слагу.

✅ 0.2

validate_payload

Проверяет полезную нагрузку на соответствие правилам конкретной страны с реальной проверкой контрольных сумм для CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE. Также проверяет продукты подписки, подписки и платежи по подпискам (биллинговый цикл, политика повторных попыток PIX_SPECIFIC, неизменяемость). Выявляет нецелые младшие единицы, неверную валюту для страны, не-HTTPS вебхуки, несоответствия метода и страны, отсутствующие ключи идемпотентности и многое другое.

✅ 0.3 / 0.4

get_webhook_playbook

Канонический контракт вебхуков PayRetailers: схема конверта, полный словарь событий (транзакции, выплаты, подписки, платежи по подпискам), политики повторных попыток, рекомендации по подписи/воспроизведению, 6 главных ошибок.

✅ 0.4

validate_webhook_handler

Анализирует декларативное описание дизайна приёмника вебхуков и возвращает машиночитаемые {errors, warnings, info}. Выявляет подтверждение после обработки, отсутствие идемпотентности, бизнес-ошибки как 500, предположения о порядке по времени, отключённую подпись в продакшене.

✅ 0.4

simulate_transaction

Выполняет реальный запрос к песочнице PayRetailers с использованием учётных данных разработчика из окружения.

🚧 планируется

Промпты

Готовые шаблоны, которые разработчик может выбрать с помощью / в Cursor / Claude Desktop / и т.д.

Промпт

Что запускает

Фаза

integrate-pix-payin

Генерирует полную интеграцию PIX-платежа для Бразилии на выбранном вами языке.

✅ 0.1

integrate-payout-fx

Кросс-валютная выплата с обработкой 5-минутного TTL котировки FX.

✅ 0.2

build-checkout

Чек-аут с учётом страны: фронтенд-выбор + бэкенд-эндпоинт + приёмник вебхуков.

✅ 0.2

debug-401-auth

Диагностика HTTP 401/403 (ключ подписки, Basic Auth, IP-белый список, путаница окружений).

✅ 0.2

reconcile-with-graphql

Создание конвейера сверки с использованием Merchant Data GraphQL API.

✅ 0.2

implement-webhook-handler

Генерация продакшен-уровневого приёмника вебхуков для запрошенного стека, области и бэкенда очередей. Обеспечивает четыре неоспоримых требования (быстрый ответ 200, дедупликация по eventId, строгая подпись, никогда не подтверждать до терминального статуса).

✅ 0.4

integrate-subscriptions

Генерация полной интеграции подписок для заданной страны + канала (продукт + активация + подписка + списание + повторные попытки + отмена).

✅ 0.4


Установка

Два поддерживаемых пути. Выберите один:

  • Вариант A — Готовый zip-архив из GitHub Releases (рекомендуется на данный момент): не нужен аккаунт npm, не нужна компиляция, работает полностью офлайн после загрузки. Это официально поддерживаемый способ распространения, пока @payretailers/mcp ещё не опубликован на npm.

  • Вариант B — Сборка из исходников: для контрибьюторов и для развёртываний с повышенными требованиями к безопасности, где нужно проверить код перед запуском.

Вариант C — установка из npm как @payretailers/mcp — запланирован, но пока недоступен. Когда пакет будет опубликован, фрагменты npx -y @payretailers/mcp в разделе Настройка по клиенту заработают без дополнительных действий.

Вариант A — Установка из GitHub Releases

Предварительные требования: Node.js 20 или новее (node --version). Больше ничего не нужно — zip-архив релиза самодостаточен.

  1. Откройте страницу Releases и скачайте последний payretailers-mcp-vX.Y.Z.zip из раздела «Assets» верхнего релиза.

  2. Распакуйте его в любое место. Часто используемые расположения:

    • Windows: C:\Tools\payretailers-mcp

    • macOS / Linux: ~/tools/payretailers-mcp

  3. Добавьте сервер в ваш MCP-клиент (см. Настройка по клиенту ниже или пошаговые руководства по ссылкам там). Укажите абсолютный путь к dist/index.js внутри распакованной папки.

  4. Перезагрузите / перезапустите ваш MCP-клиент. Сервер появится рядом с вашими остальными инструментами.

Пошаговые руководства по настройке со скриншотами и проверочными запросами:

Необязательная быстрая проверка до или после подключения — подтверждает, что сборка полностью работоспособна:

cd /path/to/payretailers-mcp-X.Y.Z
node scripts/smoke-test.mjs

Ожидаемый результат: PASS ✅ в конце, с объявленными 7 инструментами, 158 ресурсами, 7 промптами, 5 шаблонами ресурсов.

Вариант B — Сборка из исходников

Для контрибьюторов или если ваша политика безопасности требует проверить код перед запуском. Предварительные требования: Node.js 20 или новее, git.

git clone https://github.com/payretailers-dev/payretailers-mcp.git
cd payretailers-mcp
npm install
npm run build          # generates dist/index.js (bundle + runtime deps)
npm start              # optional: run over stdio manually (Ctrl+C to stop)

data/ (Guides, Skills, Reference, Recipes, концепт-документы, курируемый JSON) включён в репозиторий — вам не нужен npm run sync:docs, если только вы не зеркалируете обновлённый checkout payretailers-ai-docs на той же машине.

Затем подключите dist/index.js к вашему MCP-клиенту так же, как в варианте A.


Настройка по клиенту

Предпочитаете полное прохождение с проверочными запросами и устранением неполадок? См. пошаговые руководства в docs/setup/ для Cursor, Claude Code, Claude Desktop и VS Code + Copilot. Фрагменты ниже — это минимальный JSON, если вы уже знаете свой клиент.

Каждый клиент принимает одни и те же три элемента информации: команду (node), массив args с абсолютным путём к dist/index.js и необязательный блок env для будущего инструмента simulate_transaction.

Замените C:/Tools/payretailers-mcp/dist/index.js ниже на абсолютный путь, куда вы распаковали релиз. В Windows используйте прямые слэши в JSON — обратные слэши нужно экранировать, и они вызывают запутанные ошибки.

Cursor

Добавьте в ~/.cursor/mcp.json (глобально) или .cursor/mcp.json (для проекта):

{
  "mcpServers": {
    "payretailers": {
      "command": "node",
      "args": ["C:/Tools/payretailers-mcp/dist/index.js"],
      "env": {
        "PAYRETAILERS_ENV": "sandbox",
        "PAYRETAILERS_SHOP_ID": "your_sandbox_shop_id",
        "PAYRETAILERS_SECRET_KEY": "your_sandbox_secret_key",
        "PAYRETAILERS_SUBSCRIPTION_KEY": "your_sandbox_subscription_key"
      }
    }
  }
}

Блок env необязателен — Resources, search_docs и все валидаторы работают без каких-либо учётных данных.

Claude Desktop

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

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "payretailers": {
      "command": "node",
      "args": ["C:/Tools/payretailers-mcp/dist/index.js"]
    }
  }
}

Windsurf

Добавьте в ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "payretailers": {
      "command": "node",
      "args": ["C:/Tools/payretailers-mcp/dist/index.js"]
    }
  }
}

VS Code + Copilot

Добавьте в .vscode/mcp.json (для рабочей области) или откройте пользовательский файл через Command Palette → MCP: Open User Configuration:

{
  "servers": {
    "payretailers": {
      "type": "stdio",
      "command": "node",
      "args": ["C:/Tools/payretailers-mcp/dist/index.js"]
    }
  }
}

Примечание: VS Code — исключение — корневой ключ называется "servers" (а не "mcpServers"). MCP-инструменты работают только в режиме Agent в Copilot Chat.

Zed

Добавьте в ~/.config/zed/settings.json:

{
  "context_servers": {
    "payretailers": {
      "command": {
        "path": "node",
        "args": ["C:/Tools/payretailers-mcp/dist/index.js"]
      }
    }
  }
}

Continue.dev

Добавьте в ~/.continue/config.json:

{
  "mcpServers": [
    {
      "name": "payretailers",
      "command": "node",
      "args": ["C:/Tools/payretailers-mcp/dist/index.js"]
    }
  ]
}

JetBrains AI Assistant

Откройте Settings → AI Assistant → MCP Servers → Add и введите:

  • Name: payretailers

  • Command: node

  • Arguments: C:/Tools/payretailers-mcp/dist/index.js (абсолютный путь)

Другие клиенты

Любой клиент, поддерживающий MCP через stdio, может использовать этот сервер. Укажите node <абсолютный-путь>/dist/index.js — и готово.

Когда npm станет доступен

Когда @payretailers/mcp будет опубликован на npm, те же конфигурации заработают с более короткой формой:

{ "command": "npx", "args": ["-y", "@payretailers/mcp"] }

Никаких изменений в env, не нужно хранить распакованную папку.


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

После перезагрузки MCP-клиента вы должны увидеть в статусе сервера примерно следующее:

7 инструментов · 158 ресурсов · 7 промптов · 5 шаблонов ресурсов

  • Cursor: Ctrl+Shift+P → Customize → вкладка MCPs. Найдите payretailers с зелёной точкой и разверните его.

  • Claude Desktop: проверьте панель инструментов в новом чате; инструменты PayRetailers должны появиться рядом с другими вашими MCP.

  • VS Code / Zed / Continue.dev / Windsurf: обратитесь к документации каждого клиента по панели статуса MCP.

Если кажется, что ваш ассистент не вызывает инструменты, принудительно вызовите их один раз, начав промпт с «Используй PayRetailers MCP, чтобы...». После того как инструмент будет вызван один раз в беседе, ассистент обычно продолжает это делать.


Устранение неполадок

Сервер не запускается. Запустите сборку вручную из терминала:

node /path/to/payretailers-mcp/dist/index.js

Если он молча ожидает ввода — сборка в порядке, проблема на стороне клиента (опечатка в пути в конфиге, прямые слэши vs обратные в Windows, перезапущен не тот процесс). Если выводится ошибка, самые частые причины — Node < 20 (обновите Node) или повреждённая загрузка (скачайте zip заново).

Клиент показывает старые счётчики (например, 5 инструментов, 89 ресурсов). Некоторые клиенты кэшируют перечисление MCP-инструментов и ресурсов. Переключите сервер OFF → ON на панели MCP клиента или добавьте неиспользуемую запись env в конфиг (например, "MCP_VERSION": "0.4.1"), чтобы принудительно перезапустить процесс.

Модель, похоже, не вызывает ни одного MCP-инструмента. Убедитесь, что чат находится в режиме Agent (не Ask / режиме только для чтения). Некоторые лёгкие модели менее охотно вызывают инструменты — переключитесь на модель верхнего уровня для первых вызовов, и ассистент запомнит, что инструменты доступны на протяжении остальной беседы.

Где логи? У каждого MCP-клиента есть панель логов MCP, которая фиксирует JSON-RPC handshake, ошибки парсинга и stderr сервера. В Cursor: Ctrl+Shift+U → выпадающий список → MCP Logs.


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

Необязательные — требуются только для будущего инструмента simulate_transaction (фаза 4). Всё остальное (Resources, search_docs, Prompts) работает без каких-либо учётных данных.

Переменная

Описание

По умолчанию

PAYRETAILERS_ENV

sandbox или production.

sandbox

PAYRETAILERS_SHOP_ID

Ваш Shop ID из портала мерчанта.

(не задан)

PAYRETAILERS_SECRET_KEY

Ваш секретный ключ для HTTP Basic Auth.

(не задан)

PAYRETAILERS_SUBSCRIPTION_KEY

Значение заголовка Ocp-Apim-Subscription-Key.

(не задан)

Безопасность: сервер никогда не логирует учётные данные и не сохраняет их. Они хранятся в памяти на время сессии и отправляются только на api-sandbox.payretailers.com или api.payretailers.com, когда вы вызываете simulate_transaction.


Пример использования

После настройки задайте вашему ИИ-ассистенту вопрос на простом языке:

«Создай мой первый PIX payin в песочнице на R$50 в Бразилии. Используй Node.js.»

Под капотом ассистент:

  1. Вызовет search_docs({ query: "pix payin brazil" }) → найдёт навык brazil-pix-payin.

  2. Прочитает payretailers://skill/brazil-pix-payin для точных шагов.

  3. Сгенерирует исполняемый код с правильным endpoint, заголовками, минорными единицами и форматом CPF.

Или используйте промпт /integrate-pix-payin напрямую для полностью структурированного ответа.

Проверка payload перед отправкой

Когда ассистент подготовил payload, он может проверить его перед обращением к API:

// tools/call → validate_payload
{
  "operation": "create-transaction",
  "country": "BR",
  "method": "PIX",
  "payload": {
    "trackingId": "abc-12345678",
    "amount": 100.50,              // will be flagged: use 10050 (minor units)
    "currency": "USD",             // will be flagged: BR expects BRL
    "notificationUrl": "http://example.com/wh", // will be flagged: must be HTTPS
    "customer": {
      "firstName": "Ana",
      "lastName": "Santos",
      "email": "ana@example.com",
      "personalId": "12345678900"  // will be flagged: invalid CPF checksum
    }
  }
}

Ответ перечисляет все проблемы с code, severity, path, message и часто с hint и suggestion — LLM может исправить payload, не тратя сетевой запрос впустую.


Разработка

git clone https://github.com/payretailers-dev/payretailers-mcp.git
cd payretailers-mcp
npm install
npm run build          # generates dist/index.js
npm test               # 93 unit tests
node scripts/smoke-test.mjs   # end-to-end stdio handshake + tool calls
npm start              # optional: run the server manually on stdio

data/ (Guides, Skills, Reference, Recipes, концепт-документы, курируемый JSON) включён в репозиторий. Запускайте npm run sync:docs только если у вас есть checkout ../payretailers-ai-docs и вы хотите обновить зеркало.

Сервер можно проверить с помощью официального MCP Inspector:

npx @modelcontextprotocol/inspector node dist/index.js

Релизы (для мейнтейнеров)

Релизы автоматизированы через GitHub Actions при пуше тега (v*.*.*). Процесс:

  1. Запускает lint, typecheck, unit-тесты, сборку и smoke-тест.

  2. Запускает npm run pack:release для создания release/payretailers-mcp-vX.Y.Z.zip (собранный dist/index.js + зеркало data/ + README + LICENSE + CHANGELOG + smoke-тест).

  3. Создаёт GitHub Release и прикрепляет zip.

  4. Публикует на npm как @payretailers/mcp только если настроен секрет репозитория NPM_TOKEN — в противном случае релиз доступен только на GitHub.

Чтобы выпустить релиз локально, затем запушьте тег:

# 1. Bump version in package.json, config.ts, CHANGELOG.md
# 2. Verify locally
npm run clean && npm ci && npm test && npm run build
node scripts/smoke-test.mjs
npm run pack:release        # writes release/payretailers-mcp-vX.Y.Z.zip

# 3. Commit + tag + push
git add -A
git commit -m "chore: release vX.Y.Z"
git tag vX.Y.Z
git push origin main
git push origin vX.Y.Z      # this triggers .github/workflows/release.yml

Семантическое версионирование строго соблюдается: патч-релизы исправляют ошибки, минорные релизы добавляют инструменты/промпты/ресурсы без нарушения существующих, мажорные релизы — только для переименований/удалений.


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

  • 0.1 ✅ Resources (Guides, Skills), search_docs, промпт integrate-pix-payin.

  • 0.2 ✅ Resources (Reference, Recipes), get_country_rules, get_test_data, get_endpoint_spec, промпты integrate-payout-fx, build-checkout, debug-401-auth, reconcile-with-graphql.

  • 0.3 ✅ validate_payload с реальной проверкой контрольных сумм для CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE + сквозные правила (минорные единицы, валюта/страна, HTTPS webhook, метод/страна, идемпотентность).

  • 0.4 ✅ Категория ресурсов концепт-документов, get_webhook_playbook, validate_webhook_handler, расширенный validate_payload для операций подписки, промпты implement-webhook-handler, integrate-subscriptions.

  • 0.4.1 ✅ Выравнивание схемы подписок (AmountModel, перечисление frequency, authorizationType) — CHANGELOG.md.

  • 0.5 — simulate_transaction (пробный прогон против песочницы), get_error_code, расширенное покрытие стран.

  • 1.0 — Стабильный публичный релиз + включение в официальный MCP Registry + публикация на npm.

Подробности см. в CHANGELOG.md.


Связанные материалы


Лицензия

Исходный код: MIT. См. LICENSE.

Документация, включённая в data/ (Guides, Skills, Reference, Recipes), лицензирована по CC BY-ND 4.0, унаследована из репозитория payretailers-ai-docs. Курируемые файлы данных (data/country-rules.json, data/test-data.json) также выпущены под CC BY-ND 4.0.


Участие в разработке

Отчёты об ошибках и запросы функций приветствуются через GitHub Issues. Pull request'ы от сообщества рассматриваются, но объединяются по усмотрению команды PayRetailers — см. CONTRIBUTING.md, когда он появится.

Available Tools

7 tools
get_country_rulesA

Return the country-specific rules for a PayRetailers integration: accepted currencies, personalId format (CPF, DNI, CLABE, RUT, ...), payment method constraints, and regulatory notes. Call this before emitting any country-specific payload.

NameRequiredDescriptionDefault
methodNoOptional payment method filter (e.g. 'PIX', 'ALIAS_CVU', 'SPEI', 'CARD', 'BRE_B'). If omitted, returns full country rules.
countryYesISO 3166-1 alpha-2 country code. Supported: BR, AR, MX, CO, CL, PE. Use uppercase.

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and it does well: 'Return' signals a safe read, and the description discloses exactly what the response contains (currencies, personalId, constraints, notes). It adds the workflow context of calling before payload emission. It doesn't cover failure behavior for unsupported countries, but the core behavior is transparent.

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 two sentences of densely packed information: the purpose plus content enumeration, followed by a single directive. No filler, and the most important constraint (when to call) is placed clearly at the end.

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 lookup with 2 fully-documented parameters and no output schema, the description compensates well by detailing what the return value contains. The only minor omission is error handling for unsupported country codes, but the schema already lists the supported countries, so the description is complete for correct invocation.

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%, so both 'country' and 'method' are already well documented in the schema, including the supported values and formatting rules (uppercase, ISO code). The description adds no parameter detail beyond what the schema provides, so the baseline of 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?

The description uses a specific verb ('Return') and resource ('country-specific rules') and enumerates the exact content: accepted currencies, personalId formats, payment method constraints, and regulatory notes. This clearly distinguishes it from siblings like search_docs and get_endpoint_spec, which serve different lookup purposes.

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 provides an explicit when-to-call directive: 'Call this before emitting any country-specific payload.' This frames the tool as a prerequisite step in the integration flow. It lacks explicit exclusions or named alternatives, but the precondition is clear and actionable.

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

get_endpoint_specA

Return the full reference page (parameters, response, error codes) for a specific PayRetailers endpoint. Use this to ground your generated code against the exact request/response schema before emitting it.

NameRequiredDescriptionDefault
sectionNo'full' returns the entire reference page. 'summary' returns just the top of the page. Default 'full'.
endpointYesEndpoint slug or logical name. Examples: 'create-transaction', 'create-payout', 'createpayoutquote', 'get-payment-methods', 'post_v1-subscriptions'. Case-insensitive.

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses what the tool returns (parameters, response, error codes), which is the core behavior. However, it doesn't mention any potential error handling, rate limits, or any side effects. As a read-only retrieval, this is acceptable but not exceptionally transparent.

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?

Two concise sentences. The first sentence states the core function, and the second provides usage context. No filler words, and the most critical information is front-loaded.

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?

Since there is no output schema, the description correctly explains what the response contains ('parameters, response, error codes'). It covers the essential information for a retrieval tool. The 'section' parameter is described in the schema, so no need to repeat. Slightly more could be said about expected size or format, but it is adequate.

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%, so the baseline is 3. The description does not add any extra meaning beyond what the schema already documents for 'section' and 'endpoint' – it simply restates the purpose.

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 verb ('Return'), a clear resource ('full reference page'), and the specific content ('parameters, response, error codes'). It clearly distinguishes itself from siblings like search_docs by being the tool that retrieves a specific endpoint's spec.

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?

It provides a clear use case: 'to ground your generated code against the exact request/response schema before emitting it.' This tells the agent when to use it. It doesn't explicitly mention alternatives, but the sibling list includes search_docs, which is likely for broader searching, so the context is clear.

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

get_test_dataA

Return official-shaped sandbox test data for a country: sample customers (name, email, personalId in correct format, address), test cards (approved/declined), and PIX/Bre-B keys where applicable. Use this to populate sandbox requests with realistic values instead of inventing them.

NameRequiredDescriptionDefault
countryYesISO 3166-1 alpha-2 country code. Supported: BR, AR, MX, CO, CL, PE.
sectionNoWhich section of test data to return. 'all' returns everything. Defaults to 'all'.

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. The description implies a read-only data fetch (returning data) but does not explicitly state that it makes no changes or that it is safe to call. It also does not mention error cases, rate limits, or the exact structure of the returned data. Adequate for a simple retrieval, but lacks depth given the absence of annotations.

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?

Two sentences with zero filler. The primary action and scope are front-loaded, followed by a concise usage recommendation. Every word earns its place; no redundancy.

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 only 2 parameters, no output schema, and no nested objects, the description covers the essential information: what is returned, its purpose, and how to invoke it. It could optionally describe the response structure more explicitly, but the types of data are listed, which is sufficient 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.

Parameters3/5

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

Schema description coverage is 100% — both 'country' and 'section' have descriptions, including supported values and defaults. The description adds context about why these parameters matter (to populate realistic sandbox requests) but does not add syntax or format details beyond what the schema already covers. Baseline of 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?

The description clearly states the verb 'Return' and the resource 'official-shaped sandbox test data for a country', enumerating the exact contents (customers, test cards, PIX/Bre-B keys). This is specific and distinct from sibling tools like get_country_rules or get_endpoint_spec, making it easy for an agent to identify this as the correct tool for generating test data.

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 says 'Use this to populate sandbox requests with realistic values instead of inventing them', which gives clear context on when to use it. It does not explicitly state when not to use it or compare to alternatives, but the purpose is clear enough that an agent would not confuse it with the sibling tools.

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

get_webhook_playbookA

REQUIRED before implementing any webhook receiver or reconciliation flow. Returns the canonical PayRetailers webhook contract: envelope schema, complete event vocabulary (transaction lifecycle: PENDING/IN_PROGRESS/APPROVED/REJECTED/CANCELLED/EXPIRED/REFUNDED/CHARGEBACK; payout lifecycle; subscription and subscription_payment events with retry semantics), HTTP response contract (200 fast / 400 no-retry / 500 retried), idempotency by eventId, replay protection, signature verification, retry policies (PIX_SPECIFIC / FIXED_RETRY / NOT_ALLOWED), and the top 6 wrong-way patterns integrators hit. Filter by category or eventType for a focused answer. Do not attempt to design a webhook handler from memory — call this tool first.

NameRequiredDescriptionDefault
categoryNoFilter events by lifecycle. 'transaction' = payin events; 'payout' = payout events; 'subscription' = subscription entity events (activation/cancellation); 'subscription_payment' = recurring charge events; 'all' (default) returns the complete catalog.
eventTypeNoFilter by a specific eventType string (e.g. 'subscription.payment', 'transaction'). Case-sensitive as declared by the API.
includeDeliveryNoInclude the delivery / retry / signature section. Defaults to true. Set to false if you only need the event vocabulary.

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries full disclosure burden. It states the tool is a read-only retrieval operation ('Returns') and details all delivered content: event vocabulary, retry policies, signature verification, etc. It does not claim any side effects or mutations. The emphasis that integrators should not rely on memory signals the tool's authoritative nature. This is sufficient behavioral transparency for a query tool.

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 long but densely packed with essential information, organized as a list of contract aspects and retry policies. The mandatory-use warning is front-loaded, and every sentence contributes value. While verbose, the complexity of webhook contracts justifies the detail; there is no redundant filler.

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?

There is no output schema, so the description must explain the return value, and it does so extensively: it lists envelope schema, event categories, HTTP response codes, idempotency, replay protection, signature verification, retry policies, and common mistakes. It also explains parameter usage for scoping results. For a reference tool covering a complex integration surface, this is complete.

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% and the three parameters (category, eventType, includeDelivery) are fully documented in the schema with enums and examples. The description only adds a generic suggestion to filter by category or eventType, but does not introduce new semantic meaning beyond the schema. Per the rubric, baseline 3 is appropriate when the schema handles parameter documentation.

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 verb ('Returns') and resource ('canonical PayRetailers webhook contract') and enumerates the exact contents: envelope schema, event vocabulary, HTTP response contract, idempotency, replay protection, signature verification, retry policies, and common pitfalls. This clearly differentiates it from siblings like search_docs or get_endpoint_spec, which are generic or endpoint-specific rather than webhook-contract-specific.

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

Usage Guidelines5/5

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

The description explicitly mandates when to use the tool: 'REQUIRED before implementing any webhook receiver or reconciliation flow' and 'Do not attempt to design a webhook handler from memory — call this tool first.' It also advises filtering by category or eventType for focused answers, giving clear guidance on how to invoke it effectively. No alternatives are mentioned, but the tool is positioned as the definitive prerequisite, so exclusion guidance is unnecessary.

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

search_docsA

Search across PayRetailers Guides and Skills. Returns top matches with a short snippet. Use this before answering any integration question to ground your response in the official documentation.

NameRequiredDescriptionDefault
limitNoMaximum number of results to return. Default 10.
queryYesFree-text query. Examples: 'pix payout', 'validate cpf', 'fx quote'.
categoryNoOptional category filter. 'guide' = end-to-end tutorial. 'skill' = task-focused workflow.

TDQS

A4/5.0
Behavior3/5

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

Annotations are absent, so the description carries the full burden. It discloses the search-and-return behavior (returning matches with snippets) but does not mention permissions, rate limits, or side effects. It's adequate for a search tool but leaves notable gaps in behavioral disclosure.

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?

Two tightly written sentences: the first states the purpose and output, the second gives the usage directive. Every word earns its place, and the key information is front-loaded.

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 straightforward 3-parameter tool with full schema coverage and no output schema, the description supplies enough context for correct usage, including a strong usage hint. It omits details like pagination or error handling, but these are minor for a search tool.

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?

The schema already provides 100% coverage with rich descriptions (e.g., query examples, category enum explanations, limit bounds). The description adds little beyond restating the scope, so it meets the baseline for high schema coverage.

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 a specific verb ('Search'), a distinct resource ('PayRetailers Guides and Skills'), and the output format ('top matches with a short snippet'). This effectively differentiates it from sibling tools that fetch specific data (e.g., get_endpoint_spec, get_country_rules).

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 an explicit 'when to use' directive: 'Use this before answering any integration question to ground your response in the official documentation.' This clearly signals the primary use case, but it lacks explicit mention of alternatives or when not to use the tool, so it doesn't reach a 5.

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

validate_payloadA

REQUIRED whenever the user shows or you are about to emit a JSON body for POST /transactions, POST /payouts, POST /customers, POST /v1/subscription-products, POST /v1/subscriptions, or POST /v1/subscription-payments — even if the payload looks correct. Runs the same checks a senior PayRetailers integrator would run in code review: country-specific document checksum (CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE), minor-units-as-string amount format, currency/country match, HTTPS notificationUrl, method/country compatibility (PIX only BR, BRE_B only CO, SPEI only MX, etc.), idempotency key length, trackingId ≤ 50 chars, customer required fields matrix (customer.ip / customer.country always; city+address in CO or card in EC/MX; zip on cards in EC/MX; phone on Boleto/Efecty/PagoEfectivo/Yape/Plin/WesternUnion-PA/African methods). For subscriptions: enforces billingCycle shape, Bacen PIX_SPECIFIC contract (maxRetries=3 / retryIntervalDays=7 fixed for BR PIX Automático), FIXED_RETRY config completeness, and authorisationJourney vocabulary (BACKGROUND / USER_INTERACTION). Returns machine-readable {errors, warnings, info} with code, path, severity, hint and often a suggestion — pipe those back into the corrected payload before you show any curl / SDK call to the user. Do not skip: a payload that 'looks fine' but hits the API returns generic 4xx errors that are far harder to interpret than the codes this tool emits.

NameRequiredDescriptionDefault
methodNoPayment method (e.g. 'PIX', 'CARD', 'SPEI', 'BRE_B', 'ALIAS_CVU'). Enables method-specific rules.
countryNoISO 3166-1 alpha-2 country code. If omitted, taken from payload.country. Determines the personalId format to validate.
payloadYesThe JSON body you're about to POST to the PayRetailers API. Pass it verbatim (no headers, just the body).
operationYesWhich PayRetailers operation the payload targets. Each operation has its own required fields.
environmentNo'sandbox' allows local/private notificationUrls (with a hint). 'production' rejects them. Default: 'sandbox'.
personalIdTypeNoExplicit personalId type. If omitted, inferred from country + value shape (e.g. BR + 11 digits → CPF).

TDQS

A4.3/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses the return format ({errors, warnings, info} with code, path, severity, hint, suggestion) and warns that 'looks fine' payloads still need validation—setting expectations that the tool may catch issues even when the user thinks they're correct. It does not explicitly state non-behavior like 'does not make API calls' or 'no side effects', but the description implies a read-only validation function. It adds substantial context beyond the schema, justifying a 4.

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

Conciseness3/5

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

The description is very long, though it front-loads the critical usage note ('REQUIRED whenever') and structures the validations as a list. Every sentence adds useful detail, but it could be more concise by grouping related checks. For a tool with high complexity, the length is defensible, but it is not tightly packed—several clauses could be trimmed without loss of meaning.

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?

Given the tool's complexity (6 parameters, nested objects, many validation rules) and the absence of an output schema, the description is remarkably complete. It covers all the inputs' roles, the full set of validations, the output structure, and why skipping is risky. An agent would have everything needed to decide whether and how to call it correctly.

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 stated as 100%, so the baseline is 3. The description reinforces parameter roles (e.g., 'operation' selects the rule set, 'environment' affects notificationUrl checks, 'personalIdType' inference) but adds no new parameter info beyond what the schema already describes. It does contextualize why parameters matter, but not enough to exceed 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, actionable purpose: validating JSON payloads for a defined set of PayRetailers POST endpoints. It enumerates the exact operations and lists the specific validation checks (CPF/CNPJ checksums, amount format, currency/country match, etc.), making the tool's function unambiguous and distinct from sibling tools like search_docs or get_endpoint_spec.

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

Usage Guidelines5/5

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

Explicitly states when the tool is REQUIRED ('REQUIRED whenever... even if the payload looks correct') and explains why (generic 4xx errors are hard to interpret). It also directs the user to pipe the returned errors/warnings back into the payload, effectively telling them the expected workflow. No exclusions or alternatives are mentioned, but the tool is clearly the primary validator for these operations.

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

validate_webhook_handlerA

REQUIRED whenever the user is designing, describing, or about to code a webhook receiver for PayRetailers — even if the design looks fine. Analyses a declarative description of the handler (URL, processing mode, ack strategy, idempotency, signature verification, replay protection, error mapping, ordering assumptions) against the PayRetailers contract and returns {errors, warnings, info} with actionable codes. Catches the top failure modes: acknowledging AFTER processing (times out and gets retried), returning 500 on business errors (infinite retries), missing eventId de-duplication (double-fulfilment), assuming wall-clock order (state corruption), HTTPS missing, signature disabled in production, replay window absent. Pair with get_webhook_playbook when designing from scratch.

NameRequiredDescriptionDefault
urlYesThe public URL that will receive PayRetailers webhook POSTs.
orderingNoWhether the handler relies on wall-clock order of events for the same entityId. Real deliveries can arrive out-of-order; a handler that assumes order will corrupt state.
ackStrategyYesWhen the handler returns 200: 'before-processing' (recommended), 'after-processing' (blocks retries but risks timeouts), 'conditional-on-outcome' (dangerous: business errors trigger retries).
environmentNoDeployment target for this handler. Defaults to 'sandbox'.
ipAllowlistNoOptional IP allowlist. NOT sufficient by itself — always combine with signature verification.
errorHandlingNoHow the handler maps internal exceptions to HTTP status. Business errors ('order not found') should NOT return 500 — that triggers infinite retries.
processingModeYesHow the handler processes the event: 'sync-in-request' = all business logic runs before returning 200; 'async-queue' = enqueue and return 200 immediately (recommended); 'async-thread' = fire-and-forget in-process background thread.
languageOrStackNoOptional stack hint (e.g. 'C# ASP.NET 8', 'Node.js Express', 'Python FastAPI'). Only used to sharpen suggestions.
replayProtectionNoOptional replay protection based on eventDate. Recommended: enabled=true with maxAgeMinutes=5.
idempotencyStrategyYesHow duplicate deliveries are de-duplicated. 'by-eventId' is the required strategy.
signatureVerificationYesHow the handler treats the PayRetailers webhook signature. 'strict' = reject on mismatch (recommended); 'log-only' = log and continue; 'disabled' = no verification (only acceptable for sandbox).
idempotencyStoreTtlDaysNoHow long processed eventIds are retained. Recommended >= 30 days to survive replay attempts and backlogs.
responseTargetLatencyMsNoExpected p95 latency of your endpoint in milliseconds. PayRetailers targets < 3000 ms for the 200 ack.

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It clearly states the return structure ({errors, warnings, info} with actionable codes) and the specific failure modes it catches (acknowledging after processing, returning 500 on business errors, missing idempotency, etc.), giving an agent a concrete mental model of what the tool will do. It does not go into output detail beyond that, but for a static-analysis/validation tool this is adequate; a 4 is warranted because it is explicit and actionable without being exhaustive.

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 longer than typical but every sentence earns its place: the usage directive is front-loaded, the evaluation scope is itemized, and the failure-mode list is concrete and useful. The only slight inefficiency is the duplication of some schema-derived concepts (like the retry risks), but overall it's tightly packed with high-signal guidance rather than filler.

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?

Given the tool's complexity (13 parameters, 6 enums, nested objects, no output schema), the description is remarkably complete. It states the contract (payload fields), the output format, the key failure modes, and even mentions pairing with a related tool. It could include an example of the 'actionable codes', but the description's coverage of usage, scope, and behavior is sufficient for an agent to decide whether to call it and roughly what to provide.

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% — every parameter has a substantive description (e.g., ackStrategy explains the three options and warns about 'conditional-on-outcome', idempotencyStrategy says 'by-eventId' is required). The tool description itself adds only a few high-level hints (like the list of failure modes that map to parameters) but does not go beyond what the schema already explains. Since the schema does the heavy lifting, the baseline 3 is appropriate; the description reinforces but does not add new parameter-specific meaning.

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 names a specific verb ('Analyses') and a precise resource ('a declarative description of the handler... against the PayRetailers contract') and enumerates the exact inputs (URL, processing mode, ack strategy, etc.) and the output shape ({errors, warnings, info}). It also distinguishes itself from the sibling get_webhook_playbook by naming it explicitly, leaving no ambiguity about which tool fits a design-from-scratch task.

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

Usage Guidelines5/5

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

The opening word 'REQUIRED' plus the explicit trigger condition ('whenever the user is designing, describing, or about to code a webhook receiver') makes the when-to-use unmistakable. It also states an alternative ('Pair with get_webhook_playbook when designing from scratch') and even cautions that the tool is needed 'even if the design looks fine', closing off the common excuse of skipping validation.

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. 7 tool updatesv0.4.1
    • First observedget_country_rules
    • First observedget_endpoint_spec
    • First observedget_test_data
    • First observedget_webhook_playbook
    • First observedsearch_docs
    • First observedvalidate_payload
    • First observedvalidate_webhook_handler

TDQS

A4.4/5.0

Scored across 7 tools

Disambiguation5/5

Each tool targets a distinctly different aspect of the integration workflow: searching docs, retrieving country-specific rules, fetching test data, getting endpoint schemas, validating payloads, validating webhook handlers, and retrieving webhook playbook. There is no overlap in purpose, and descriptions make boundaries crystal clear.

Naming Consistency5/5

All tool names follow a consistent verb_noun snake_case pattern (search_docs, get_country_rules, validate_payload, etc.). No mixed conventions or ambiguous verbs appear, making the set predictable and easy to navigate.

Tool Count5/5

With 7 tools, the server is well-scoped for its purpose as a PayRetailers integration assistant. Each tool earns its place—offering documentation search, country rules, test data, endpoint specs, payload validation, webhook validation, and webhook playbook—without unnecessary bloat.

Completeness5/5

The tool surface comprehensively covers the core integration lifecycle: grounding in docs, country-specific rules, sandbox test data, endpoint schemas, payload validation, and webhook design/validation. It addresses the primary pain points integrators face, leaving no obvious gaps for common tasks.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers