Skip to main content
Glama

@payretailers/mcp

Servidor oficial del Model Context Protocol (MCP) para la API de pagos de PayRetailers.

Convierte cualquier asistente de IA compatible con MCP en un experto en integración de PayRetailers. Este servidor expone las guías oficiales, las habilidades tácticas, la referencia de endpoints y las herramientas de integración (búsqueda, validación específica por país, manual de webhooks) como recursos, herramientas y prompts de MCP de primera clase.

Funciona con Cursor, Claude Desktop, Claude Code, Windsurf, Antigravity, Zed, VS Code + Copilot, JetBrains IDEs, Continue.dev, Cline y cualquier otro cliente que hable MCP sobre stdio.


Por qué usarlo

Cuando instalas este servidor, tu asistente de IA deja de adivinar sobre PayRetailers y comienza a consultar la fuente de verdad en cada paso.

  • Código correcto al primer intento. El asistente lee la forma real de OpenAPI para cada endpoint (get_endpoint_spec), por lo que el código generado usa los nombres de campo, tipos y combinaciones obligatorias reales, no algo tomado de otro PSP.

  • Consciente del país desde el principio. Pide un payin PIX y el asistente sabe que PIX es solo para Brasil, espera BRL, necesita un CPF válido de 11 dígitos y que el QR caduca rápido. Pide SPEI y sabe que México requiere CURP o RFC, MXN, y que CLABE se aprovisiona de forma asíncrona. Todo impulsado por get_country_rules.

  • Payloads validados antes de llegar al sandbox. validate_payload ejecuta validación real de checksum en CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE, además de reglas transversales (unidades mínimas enteras, URLs de notificación HTTPS, coincidencia moneda/país, compatibilidad método/país, claves de idempotencia, matriz de campos obligatorios del cliente, forma de AmountModel de suscripciones, contrato de reintento de PIX Automático). Detectas errores en tu editor, no en una respuesta 400 INVALID_MODEL_SCHEMA.

  • Receptores de webhook diseñados correctamente. get_webhook_playbook devuelve el vocabulario canónico de eventos, las políticas de reintento y el contrato de firma/reproducción. validate_webhook_handler detecta los seis anti-patrones más dañinos (ack después de procesar, falta de deduplicación por eventId, errores de negocio como 500, firma deshabilitada en producción, suposiciones de orden por reloj, falta de HTTPS) antes de que escribas una sola línea de código de receptor.

  • Prompts de comando slash para los flujos difíciles. Escribe /integrate-pix-payin, /integrate-subscriptions, /implement-webhook-handler, /integrate-payout-fx, /build-checkout, /debug-401-auth o /reconcile-with-graphql y obtén una implementación con forma de producción en la pila de tu elección.

  • Cero configuración, cero red, apto para uso sin conexión. Todo se incluye en el zip de la versión. Sin cuenta, sin clave de API, sin llamadas salientes solo para responder una pregunta sobre la documentación. Las credenciales solo se necesitan para la herramienta (planificada) simulate_transaction.

En el interior tienes 7 herramientas, 7 prompts, 158 recursos de documentación (Guías + Habilidades + Referencia + Recetas + documentos conceptuales), todo reflejado textualmente desde el repositorio payretailers-ai-docs.


Related MCP server: Payments Developer Portal MCP Server

Qué expone

Recursos

Acceso estructurado y amigable para LLM a la documentación de PayRetailers.

Patrón de URI

Qué devuelve

payretailers://guide/{slug}

Una guía de integración de extremo a extremo con arquitectura, diagramas de secuencia, pasos de implementación y lista de verificación de producción.

payretailers://skill/{slug}

Un flujo de trabajo centrado en tareas que combina múltiples endpoints (por ejemplo, brazil-pix-payin, payout-fx-quote-flow).

payretailers://reference/{slug}

Una página de referencia de API individual (parámetros, respuesta, códigos de error).

payretailers://recipe/{slug}

Una receta de código corta para una operación común.

payretailers://doc/{slug}

Una página de concepto/documentación (subscription-concepts, webhooks-and-notifications, retry-policies, automatic-scheduling, clabe-per-customer, ...).

La lista completa se anuncia dinámicamente al conectar: los clientes pueden navegar por ella mediante su selector de recursos.

Herramientas

Acciones que el LLM puede invocar en lugar de adivinar.

Herramienta

Qué hace

Fase

search_docs

Búsqueda de texto completo en Guías, Habilidades, Referencia, Recetas y Documentos conceptuales con coincidencia difusa y campos de título/slug potenciados.

✅ 0.1

get_country_rules

Devuelve los campos del cliente, el formato de personalId (CPF, DNI, CURP, CC, RUT, ...), las monedas y las restricciones de método de pago para un país + método.

✅ 0.2

get_test_data

Devuelve datos de prueba del sandbox (clientes, tarjetas, claves PIX, claves Bre-B) para un país determinado.

✅ 0.2

get_endpoint_spec

Devuelve la página de referencia completa (parámetros, respuesta, códigos de error) para un endpoint específico por slug.

✅ 0.2

validate_payload

Valida un payload contra reglas específicas del país con validación real de checksum para CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE. También valida productos de suscripción, suscripciones y pagos de suscripción (ciclo de facturación, política de reintento PIX_SPECIFIC, inmutabilidad). Detecta unidades mínimas no enteras, moneda incorrecta para el país, webhooks no HTTPS, desajustes método/país, claves de idempotencia faltantes y más.

✅ 0.3 / 0.4

get_webhook_playbook

Contrato canónico de webhooks de PayRetailers: esquema de sobre, vocabulario completo de eventos (transacciones, pagos, suscripciones, pagos de suscripción), políticas de reintento, guía de firma/reproducción, los 6 errores comunes principales.

✅ 0.4

validate_webhook_handler

Analiza una descripción declarativa de un diseño de receptor de webhook y devuelve {errors, warnings, info} legibles por máquina. Detecta ack después de procesar, falta de idempotencia, errores de negocio como 500, suposiciones de orden por reloj, firma deshabilitada en producción.

✅ 0.4

simulate_transaction

Ejecuta una solicitud real contra el sandbox de PayRetailers usando las credenciales de entorno del desarrollador.

🚧 planificado

Prompts

Plantillas listas para usar que el desarrollador puede seleccionar con / en Cursor / Claude Desktop / etc.

Prompt

Qué activa

Fase

integrate-pix-payin

Genera una integración completa de payin PIX para Brasil en el lenguaje de tu elección.

✅ 0.1

integrate-payout-fx

Pago transfronterizo con manejo de TTL de cotización FX de 5 minutos.

✅ 0.2

build-checkout

Checkout consciente del país: selector de frontend + endpoint de backend + receptor de webhook.

✅ 0.2

debug-401-auth

Diagnostica HTTP 401/403 (clave de suscripción, Basic Auth, lista blanca de IP, mezcla de entornos).

✅ 0.2

reconcile-with-graphql

Construye un pipeline de conciliación usando la API GraphQL de datos del comerciante.

✅ 0.2

implement-webhook-handler

Genera un receptor de webhook de grado de producción para la pila, el alcance y el backend de cola solicitados. Hace cumplir los cuatro puntos no negociables (200 rápido, deduplicación por eventId, firma estricta, nunca confirmar antes del estado terminal).

✅ 0.4

integrate-subscriptions

Genera una integración completa de suscripciones para el país + canal dado (producto + activación + suscripción + cargo + reintento + cancelación).

✅ 0.4


Instalación

Dos rutas compatibles. Elige una:

  • Opción A — Zip precompilado desde GitHub Releases (recomendada hoy): sin cuenta de npm, sin compilación, funciona totalmente sin conexión una vez descargado. Esta es la distribución oficialmente soportada mientras @payretailers/mcp no esté aún en npm.

  • Opción B — Compilar desde el código fuente: para colaboradores y despliegues con requisitos de seguridad que quieran auditar el código antes de ejecutarlo.

La opción C — instalar desde npm como @payretailers/mcp — está planificada pero aún no disponible. Cuando el paquete se publique, los fragmentos npx -y @payretailers/mcp de la sección Configuración por cliente funcionarán directamente.

Opción A — Instalar desde GitHub Releases

Requisitos previos: Node.js 20 o posterior (node --version). Nada más — el zip de la versión es autocontenido.

  1. Abre la página de Releases y descarga el último payretailers-mcp-vX.Y.Z.zip de la sección "Assets" de la versión superior.

  2. Descomprímelo en cualquier lugar. Ubicaciones habituales:

    • Windows: C:\Tools\payretailers-mcp

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

  3. Añade el servidor a tu cliente MCP (consulta Configuración por cliente más abajo, o las guías paso a paso enlazadas allí). Apunta a la ruta absoluta de dist/index.js dentro de la carpeta descomprimida.

  4. Recarga / reinicia tu cliente MCP. El servidor aparecerá junto a tus otras herramientas.

Guías de configuración paso a paso con capturas de pantalla y comprobaciones de verificación:

Comprobación rápida opcional antes o después de conectarlo — demuestra que el paquete funciona correctamente de principio a fin:

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

Resultado esperado: PASS ✅ al final, con 7 herramientas, 158 recursos, 7 prompts, 5 plantillas de recursos anunciados.

Opción B — Compilar desde el código fuente

Para colaboradores, o si tu política de seguridad requiere auditar el código antes de ejecutarlo. Requisitos previos: Node.js 20 o posterior, 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/ (Guías, Skills, Referencia, Recetas, documentación conceptual, JSON curado) está incluido en el repositorio — no necesitas npm run sync:docs a menos que estés replicando un checkout actualizado de payretailers-ai-docs en la misma máquina.

Luego conecta dist/index.js a tu cliente MCP de la misma manera que en la Opción A.


Configuración por cliente

¿Prefieres una guía completa con comprobaciones de verificación y solución de problemas? Consulta las guías paso a paso en docs/setup/ para Cursor, Claude Code, Claude Desktop y VS Code + Copilot. Los fragmentos siguientes son el JSON mínimo necesario si ya conoces tu cliente.

Cada cliente recibe los mismos tres datos: un comando (node), un array de args que apunta a la ruta absoluta de dist/index.js, y un bloque env opcional para la futura herramienta simulate_transaction.

Reemplaza C:/Tools/payretailers-mcp/dist/index.js más abajo con la ruta absoluta donde descomprimiste la versión. En Windows usa barras diagonales en el JSON — las barras invertidas deben escaparse y causan errores confusos.

Cursor

Añade a ~/.cursor/mcp.json (global) o .cursor/mcp.json (por proyecto):

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

El bloque env es opcional — los Recursos, search_docs y todos los validadores funcionan sin credenciales.

Claude Desktop

Añade a tu 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

Añade a ~/.codeium/windsurf/mcp_config.json:

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

VS Code + Copilot

Añade a .vscode/mcp.json (espacio de trabajo) o abre el archivo de ámbito de usuario con la Paleta de comandos → MCP: Open User Configuration:

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

Nota: VS Code es el caso especial — la clave raíz es "servers" (no "mcpServers"). Las herramientas MCP solo se ejecutan en el modo Agente de Copilot Chat.

Zed

Añade a ~/.config/zed/settings.json:

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

Continue.dev

Añade a ~/.continue/config.json:

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

JetBrains AI Assistant

Abre Settings → AI Assistant → MCP Servers → Add e introduce:

  • Name: payretailers

  • Command: node

  • Arguments: C:/Tools/payretailers-mcp/dist/index.js (ruta absoluta)

Otros clientes

Cualquier cliente que hable MCP sobre stdio puede consumir este servidor. Apunta a node <ruta-absoluta-a>/dist/index.js y listo.

Cuando npm esté disponible

Cuando @payretailers/mcp se publique en npm, las mismas configuraciones funcionarán con la forma abreviada:

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

Sin cambios en env, sin necesidad de mantener una carpeta descomprimida.


Verificar que funciona

Después de recargar tu cliente MCP deberías ver, en la entrada de estado del servidor, algo como:

7 herramientas · 158 recursos · 7 prompts · 5 plantillas de recursos

  • Cursor: Ctrl+Shift+P → Customize → pestaña MCPs. Busca payretailers con un punto verde y expándelo.

  • Claude Desktop: comprueba el cajón de herramientas en un chat nuevo; las herramientas de PayRetailers deberían aparecer junto a tus otros MCP.

  • VS Code / Zed / Continue.dev / Windsurf: consulta la documentación de cada cliente para su panel de estado MCP.

Si tu asistente no parece llamar a las herramientas, fuérzalo una vez prefijando un prompt con "Usa el MCP de PayRetailers para...". Una vez que ha invocado una herramienta en una conversación, tiende a seguir haciéndolo.


Solución de problemas

El servidor no se inicia. Ejecuta el paquete manualmente desde una terminal:

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

Si permanece en silencio esperando entrada, el paquete está bien — el problema está en el lado del cliente (error tipográfico en la ruta de la configuración, barras diagonales vs. invertidas en Windows, proceso incorrecto reiniciado). Si imprime un error, las causas más comunes son Node < 20 (actualiza Node) o una descarga truncada (vuelve a descargar el zip).

El cliente muestra recuentos antiguos (p. ej. 5 herramientas, 89 recursos). Algunos clientes almacenan en caché la enumeración de herramientas/recursos MCP. Alterna el servidor OFF → ON en el panel MCP del cliente, o añade una entrada env no utilizada a la configuración (p. ej. "MCP_VERSION": "0.4.1") para forzar un reinicio.

El modelo no parece llamar a ninguna herramienta MCP. Asegúrate de que el chat esté en modo Agente (no en modo Preguntar / solo lectura). Algunos modelos ligeros son menos propensos a llamar herramientas — cambia a un modelo de primer nivel para las primeras invocaciones, y el asistente recordará que las herramientas están disponibles durante el resto de la conversación.

¿Dónde están los registros? Cada cliente MCP tiene un panel de registros MCP que captura el protocolo de enlace JSON-RPC, errores de análisis y stderr del servidor. En Cursor: Ctrl+Shift+U → desplegable → MCP Logs.


Variables de entorno

Opcionales — solo se requieren para la futura herramienta simulate_transaction (Fase 4). Todo lo demás (Recursos, search_docs, Prompts) funciona sin credenciales.

Variable

Descripción

Valor por defecto

PAYRETAILERS_ENV

sandbox o production.

sandbox

PAYRETAILERS_SHOP_ID

Tu ID de tienda del portal de comerciante.

(sin definir)

PAYRETAILERS_SECRET_KEY

Tu clave secreta para autenticación HTTP Basic.

(sin definir)

PAYRETAILERS_SUBSCRIPTION_KEY

Valor de la cabecera Ocp-Apim-Subscription-Key.

(sin definir)

Seguridad: el servidor nunca registra credenciales ni las persiste. Viven en memoria durante la sesión y solo se envían a api-sandbox.payretailers.com o api.payretailers.com cuando invocas simulate_transaction.


Ejemplo de uso

Una vez configurado, pide a tu asistente de IA en lenguaje natural:

"Crea mi primer payin PIX en el sandbox por R$50 en Brasil. Usa Node.js."

Entre bastidores, el asistente:

  1. Llamará a search_docs({ query: "pix payin brazil" }) → encontrará la skill brazil-pix-payin.

  2. Leerá payretailers://skill/brazil-pix-payin para los pasos exactos.

  3. Generará código ejecutable con el endpoint, las cabeceras, las unidades menores y el formato CPF correctos.

O usa el prompt /integrate-pix-payin directamente para una respuesta completamente estructurada.

Validar un payload antes del envío

Una vez que el asistente ha redactado un payload, puede validarlo antes de llamar a la 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
    }
  }
}

La respuesta enumera cada problema con un code, severity, path, message, y a menudo un hint y suggestion — el LLM puede corregir el payload antes de gastar un viaje de red.


Desarrollo

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/ (Guías, Skills, Referencia, Recetas, documentación conceptual, JSON curado) está incluido en el repositorio. Ejecuta npm run sync:docs solo si tienes ../payretailers-ai-docs clonado y quieres actualizar el espejo.

El servidor se puede inspeccionar con el MCP Inspector oficial:

npx @modelcontextprotocol/inspector node dist/index.js

Publicación de versiones (mantenedores)

Las versiones se automatizan mediante GitHub Actions al empujar una etiqueta (v*.*.*). El flujo de trabajo:

  1. Ejecuta lint, typecheck, pruebas unitarias, compilación y prueba de humo.

  2. Ejecuta npm run pack:release para producir release/payretailers-mcp-vX.Y.Z.zip (dist/index.js empaquetado + espejo data/ + README + LICENSE + CHANGELOG + prueba de humo).

  3. Crea una Release de GitHub y adjunta el zip.

  4. Publica en npm como @payretailers/mcp solo si el secreto del repositorio NPM_TOKEN está configurado — de lo contrario, la versión es solo de GitHub.

Para crear una versión localmente y luego empujar la etiqueta:

# 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

El versionado semántico se aplica estrictamente: las versiones de parche corrigen errores, las versiones menores añaden herramientas/prompts/recursos sin romper los existentes, las versiones mayores solo para renombramientos/eliminaciones.


Hoja de ruta

  • 0.1 ✅ Recursos (Guías, Skills), search_docs, prompt integrate-pix-payin.

  • 0.2 ✅ Recursos (Referencia, Recetas), get_country_rules, get_test_data, get_endpoint_spec, prompts integrate-payout-fx, build-checkout, debug-401-auth, reconcile-with-graphql.

  • 0.3 ✅ validate_payload con validación real de checksum para CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE + reglas transversales (unidades menores, moneda/país, webhooks HTTPS, método/país, idempotencia).

  • 0.4 ✅ Categoría de recursos de documentación conceptual, get_webhook_playbook, validate_webhook_handler, validate_payload ampliado para operaciones de suscripción, prompts implement-webhook-handler, integrate-subscriptions.

  • 0.4.1 ✅ Alineación del esquema de suscripciones (AmountModel, enumeración de frecuencia, authorizationType) — CHANGELOG.md.

  • 0.5 — simulate_transaction (prueba en seco contra el sandbox), get_error_code, cobertura de países ampliada.

  • 1.0 — Versión pública estable + listado en el Registro MCP oficial + publicación en npm.

Consulta CHANGELOG.md para más detalles.


Relacionado


Licencia

Código fuente: MIT. Consulta LICENSE.

El contenido de documentación incluido en data/ (Guías, Skills, Referencia, Recetas) está licenciado bajo CC BY-ND 4.0, heredado del repositorio payretailers-ai-docs. Los archivos de datos curados (data/country-rules.json, data/test-data.json) también se publican bajo CC BY-ND 4.0.


Contribuciones

Los informes de errores y las solicitudes de funciones son bienvenidos a través de GitHub Issues. Las solicitudes de extracción de la comunidad se revisan pero se fusionan a discreción del equipo de PayRetailers — consulta CONTRIBUTING.md cuando esté disponible.

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

ActivityStale
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers