Saltar al contenido principal

Referencia del servidor MCP

Para desarrolladores

Catálogo de herramientas​

Las categorías marcadas Modifica el estado agrupan herramientas que escriben; el resto son de solo lectura.

Cuenta

list_instances
Instancias que administra, con mcp_enabled indicando si el plan de cada una incluye el acceso por MCP.

Métricas

get_delivery_metrics
Entregabilidad del período, con tasas y tendencia.
get_geographic_stats
Aperturas y clics por país.
get_device_stats
Aperturas y clics por dispositivo.
get_unsubscribe_breakdown
Desglose de desuscripciones por motivo.
get_sender_stats
Entregabilidad de un remitente específico.

Actividad

list_activity
Eventos individuales: enviados, rebotes, quejas, aperturas, no aperturas, clics.
list_unsubscribes
Desuscripciones con fecha y motivo.
get_mail
Estado y metadatos de un correo puntual.
get_mail_logs
Bitácora de entrega SMTP de un correo.

Campañas

list_mail_campaignsget_mail_campaign
Campañas de correo de la instancia y el detalle de una: su estado, el avance de su envío y, si está pausada, el motivo y qué hacer, con el enlace a la campaña en la plataforma.
list_categories
Categorías activas de la instancia, con la que se usa por defecto. Clasifican los envíos, y cada campaña lleva una.
get_mail_campaign_stats
Cifras y tasas de una campaña de correo que ya empezó a enviar, comparadas con el promedio de sus campañas o con otra campaña, con su panel.
get_mail_campaign_breakdown
Resultados de una campaña de correo agrupados por dominio, por rebote y descarte, o por motivo de baja o de queja, en cifras.

Envío— Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.

send_mail
Envía un correo a cada destinatario indicado, con plantilla o contenido propio y un remitente masivo.
import_recipients
Importa destinatarios desde una URL o Google Drive/Sheets y devuelve una referencia de un solo uso para el envío.

Remitentes

list_senders
Remitentes verificados.
get_sendersearch_senders_by_namesearch_senders_by_email
Detalle o búsqueda de un remitente puntual.
get_sender_consent
Si un remitente exige consentimiento y contra qué finalidades.

Dominios

list_domains
Dominios de envío y su verificación.

Plantillas

list_templatesget_template
Plantillas disponibles, y el asunto, el preheader, el estado y el HTML de una, con su vista previa.
preview_template
El HTML y el asunto de una plantilla guardada con sus variables completadas con los valores de ejemplo del diseño, sin guardar nada.
list_template_versionsget_template_version
Historial de versiones de una plantilla.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
publish_templateunpublish_template
Habilita o deshabilita una plantilla para usarse en envíos.

Diseño de plantillas

get_template_formatget_template_format_example
Especificación del formato de diseño, con el anidamiento o el detalle de los tipos de módulo que se pidan, y sus ejemplos.
get_template_outlineget_template_essential
Estructura y diseño de una plantilla, para ubicar lo que se quiere cambiar.
validate_template_documentpreview_template_document
Revisa un diseño contra el formato y muestra el HTML resultante, sin guardar.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
create_templateupdate_template
Crea una plantilla en borrador o cambia sus datos o su diseño completo. El nombre no puede repetir el de otra plantilla (template_name_taken).
patch_template_document
Cambia partes del diseño de un borrador.

Biblioteca

list_catalog_templatesget_catalog_template
Plantillas de la biblioteca de Fidelizador y su diseño.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
create_template_from_catalog
Crea un borrador a partir de una plantilla de la biblioteca.

Formularios

list_formsget_form
Formularios de la instancia y su detalle (ítems, estado, link público completo).

Diseño de formularios

get_form_formatget_form_format_example
Especificación del formato de documento de un formulario y sus ejemplos.
get_form_document
Un formulario completo como documento, para editarlo.
validate_form_document
Revisa un documento sin guardar nada. Devuelve los errores, o el plan completo de lo que se guardaría junto con una huella que identifica ese plan.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
create_formupdate_form
Crea el formulario, inactivo, o reescribe uno existente. Exigen la huella del plan que usted confirmó; si algo cambió después de la revisión, se rechazan.
activate_formdeactivate_form
Activan o desactivan un formulario en dos pasos: el primero muestra qué empezaría o dejaría de recibir registros, y el segundo lo aplica con su confirmación.

Datasets

list_datasetsget_dataset
Datasets de la instancia, con cuántos contactos tiene cada uno, y el detalle de uno, con sus columnas y cuál es su identificador.
list_dataset_contacts
Contactos de un dataset, con búsqueda opcional por el identificador o por otra columna según su tipo.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
create_dataset
Crea un dataset, con sus columnas si se indican. Pregunta el identificador cuando los canales del dataset no lo definen.
add_dataset_columns
Suma columnas a un dataset. Una columna ya declarada queda como estaba. Si una columna nueva es obligatoria y un formulario conectado no la pide, el agente le pregunta si agrega la columna a esos formularios o los deja como están.
add_dataset_contact
Agrega un contacto a un dataset; la política de colisión del dataset decide qué pasa si ya existía. Si se supera la tasa de ingreso del dataset, responde 429 con Retry-After.

Listas

list_listsget_list
Listas de la instancia y el detalle de una: columnas, estado y contadores de su importación, copias a datasets y, mientras espera sus columnas, la vista previa de su archivo.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
create_list
Crea una lista vacía.
upload_list_file
Carga el archivo CSV de una lista vacía desde una URL https, OneDrive o SharePoint, o Google Drive o Sheets, y devuelve la vista previa con el campo propuesto para cada columna. Si falla, la lista sigue vacía y admite otra carga.
set_list_columns
Declara las columnas del archivo y deja en cola la importación.
merge_lists
Crea una lista con los contactos de otras. Pregunta el identificador cuando el canal de las listas no lo determina. Las listas de origen no cambian.
copy_dataset_to_list
Crea una lista con los contactos que un dataset tiene en ese momento.
copy_list_to_dataset
Agrega los contactos de una lista a un dataset. Si el dataset no declara alguna columna de la lista, pregunta antes de copiar. Repetir una copia ya hecha a ese dataset pide confirmación.
export_list
Pide la exportación de una lista; el archivo se descarga desde el panel.

Consentimiento

list_consent_rules
Estado vigente de consentimiento por identificador.
list_consent_events
Historial de eventos de consentimiento.
list_consent_termslist_consent_purposes
Términos y finalidades declaradas.

Campos

list_fields
Catálogo de campos personalizados.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
create_field
Crea un campo en el catálogo, con sus opciones si es de selección.

Contactos

get_contact_record
Ficha de un contacto: si se le puede enviar correo, su consentimiento por finalidad y lo más reciente de sus envíos, restricciones, desuscripciones, quejas y datasets, con el origen de cada registro de un dataset (formulario, API, panel o copia de una lista). Solo para el rol operativo Administrador en Mail. Cada consulta que encuentra datos queda en el log de actividad.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
register_contact_objectionblock_contact
Registran la oposición de un contacto a los correos masivos, los transaccionales o ambos, o un bloqueo temporal de todos sus envíos. Antes de registrar, el agente le muestra la restricción y le pide confirmarla. Solo para el rol operativo Administrador en Mail. Cada oposición o bloqueo queda en el log de actividad. La oposición no se levanta. El bloqueo se levanta desde la Ficha de contacto o al llegar su fecha de término, así que indíquela siempre. Una fecha de término sin zona horaria se entiende en la zona horaria de su usuario.

Facturación

get_plan_usage
Uso actual frente al límite efectivo (plan más complementos), por cada recurso del plan. Un límite de 0 significa que el plan no incluye el recurso.

Sandbox

sandbox_catalog
Escenarios que el sandbox puede simular.
Modifica el estadoEstas herramientas escriben en la cuenta del usuario: envían correos, importan destinatarios, publican plantillas. El agente pide confirmación antes de ejecutarlas.
simulate_scenario
Simula un escenario de entrega sin tocar destinatarios reales.