Documentation menu

Referência de ferramentas

Toda ferramenta que um assistente conectado pode chamar, agrupada da mesma forma como o servidor as registra. Uma ferramenta só é oferecida ao assistente se a sua conexão tiver o escopo que ela exige — não existe uma ferramenta de escrita que fique presente mas sempre retorne erro; se você não concedeu contacts:write, o assistente simplesmente não vê upsert_contacts de jeito nenhum. Veja Escopos e permissões para o que cada escopo significa.

Destrutiva, nas tabelas abaixo, é a mesma anotação do MCP que o próprio processo de revisão do Claude exige — ela marca uma ferramenta cujo efeito não pode ser desfeito trivialmente (excluir um projeto, sobrescrever uma árvore, remover um contato), não "perigosa" em algum sentido mais vago. Toda ferramenta de escrita ainda só aceita os campos que você esperaria; nenhuma delas aceita um payload bruto pelo qual o modelo pudesse contrabandear alterações arbitrárias.

Descoberta

FerramentaEscopoNotas
searchqualquer um entre projects:read / templates:read / contacts:readPesquisa projetos, modelos e listas de contatos por nome. Retorna ids opacos para o fetch. É a ferramenta que um cliente com capacidade de pesquisa aprofundada (deep research) chama automaticamente.
fetchigual ao searchResolve um id do search em seu conteúdo completo.

Design de e-mail

FerramentaEscopoDestrutivaNotas
list_projectsprojects:readId, nome e propósito de cada projeto.
get_emailprojects:readA árvore de blocos e o tema atuais de um projeto.
preview_emailprojects:readRenderiza através do pipeline real de HTML enviado por e-mail — o documento exato que um envio produziria. Vinculado a widget (veja abaixo).
list_block_typesprojects:readO catálogo completo de 44 blocos, gerado a partir do registro em tempo real — sempre atualizado, nunca mantido manualmente.
list_templatesprojects:readSeus modelos salvos, ou a galeria aprovada da comunidade.
create_projectprojects:writeOpcionalmente semeado a partir de um modelo de propósito integrado.
add_block / update_block / move_blockprojects:writeEdições na árvore, validadas por canPlace/campo da mesma forma que as edições do copiloto do estúdio.
remove_blockprojects:write✓Exclui um bloco e seus filhos.
set_themeprojects:writeCores de marca, fonte, raio do botão.
rename_projectprojects:write
delete_projectprojects:write✓Permanente.
apply_templateprojects:write✓Sobrescreve toda a árvore e o tema do projeto.
save_as_templatetemplates:writeTira um retrato (snapshot) do projeto atual e o transforma em um modelo reutilizável.
publish_landing_pageprojects:writePublica um e-mail como página web pública em /lp/<slug> e devolve a URL. O assistente é instruído a mostrar o e-mail e pedir a sua aprovação antes, como no envio.
unpublish_landing_pageprojects:writeTira a página do ar. O endereço continua reservado para você.

Público

FerramentaEscopoDestrutivaNotas
list_data_sourcescontacts:readCada fonte de dados, incluindo listas de contatos. Valores de credenciais nunca são retornados.
list_contact_listscontacts:readListas de contatos especificamente — id, nome, campos, número de linhas.
get_contact_list_summarycontacts:readContagens, totais de supressão e a divisão da verificação de e-mail, mais o status da última reverificação — nenhum dado individual de contato.
find_contactscontacts:readConsulta limitada (≤25 linhas, paginada por cursor). sortBy: "engagementScore" devolve primeiro os contatos mais quentes da lista, com a pontuação e a variação da semana. Toda chamada é registrada no log de acesso a dados pessoais, assim como uma leitura de contato pelo painel.
upsert_contactscontacts:writeAdiciona ou atualiza linhas; aplica o limite de contatos do seu plano.
remove_contactcontacts:write✓Remove uma linha permanentemente.
add_suppression / remove_suppressioncontacts:writeBloqueia ou desbloqueia um endereço em toda a conta, com o mesmo efeito do próprio link de cancelamento de inscrição de um destinatário.

Resultados

FerramentaEscopoDestrutivaNotas
get_campaign_resultsanalytics:readAberturas/cliques/respostas/receita, comparação de variantes A/B, mapa de calor de cliques. Apenas resumido — nunca eventos brutos por destinatário. Vinculado a widget.
get_form_responsesanalytics:readTotais por pergunta; respostas de texto livre são uma amostra limitada e isolada.
list_ordersanalytics:readPedidos de checkout do bloco de produto.
list_campaign_sendsanalytics:readEnvios em massa anteriores, mais recentes primeiro.
list_schedulesanalytics:readEnvios recorrentes configurados em um projeto.
mark_order_fulfilledcommerce:writeMarca um pedido físico como enviado e notifica o comprador por e-mail.
create_schedulecampaigns:sendConfigura um novo envio recorrente.
set_schedule_enabledcampaigns:send✓Marcada como destrutiva porque desativar um agendamento ativo interrompe envios futuros silenciosamente.

Envio

FerramentaEscopoDestrutivaNotas
send_test_emailcampaigns:readUma única cópia com prefixo [Test] para um endereço que você especifica — não toca no seu público real nem exige campaigns:send.
prepare_sendcampaigns:sendSomente leitura por anotação — resolve o público e renderiza uma pré-visualização, não envia nada. Retorna um confirmationToken, e quantos contatos serão pulados por endereço inválido ou por falta de consentimento. Vinculado a widget (cartão de confirmação de envio).
confirm_sendcampaigns:send✓Exige o confirmationToken exato retornado por prepare_send, sem alteração, dentro de 10 minutos. Veja Segurança para saber por quê.

Caixa de entrada e tickets

FerramentaEscopoNotas
list_mailbox_threads / get_mailbox_threadmailbox:readE-mails recebidos no seu domínio verificado. Os corpos das mensagens são isolados como conteúdo não confiável, de autoria do destinatário.
reply_to_mailbox_threadmailbox:writeEnvia a partir do endereço de mailbox exato em que o e-mail original chegou, corretamente encadeado (threaded).
list_tickets / get_ticketmailbox:readConversas de tickets de suporte. Mesmo isolamento de conteúdo não confiável.
reply_to_ticketmailbox:writeAdiciona uma mensagem do(a) proprietário(a) e envia um e-mail ao destinatário com um link de volta.

Jornadas e segmentos

FerramentaEscopoDestrutivaNotas
list_journeysjourneys:readId, nome, ativada ou não, tipo de gatilho e número de etapas de cada jornada.
get_journeyjourneys:readO fluxo completo de uma jornada, com os nomes dos seus e-mails, listas e segmentos, e tudo o que a impediria de rodar. Para uma jornada desativada que pode rodar, também retorna um enableToken.
list_segmentsjourneys:readOs segmentos salvos, com a lista de contatos e as regras de cada um.
create_segmentjourneys:writeSalva um segmento em uma lista de contatos. Respeita o limite de segmentos do seu plano.
build_journeyjourneys:writeCria uma jornada nova, ou edita uma desativada, a partir de um pedido em linguagem natural, com o copiloto de IA do construtor de jornadas. Usa um turno do copiloto de IA. O resultado é sempre salvo desativado, e uma jornada ativada nunca é alterada.
set_journey_enabledjourneys:write (+ campaigns:send para ativar)✓Ativar uma jornada exige o enableToken de get_journey, sem alterações, em até 10 minutos e sem edições no meio do caminho. A mesma ideia de duas etapas de prepare_send/confirm_send. Pausar não exige nenhum dos dois.

Conta

FerramentaEscopoNotas
get_plan_usagenenhum — sempre disponívelPlano, cotas e o uso deste mês. Somente leitura, e não é um dado de conta sensível como projetos/contatos/mailbox, então fica disponível independentemente de quais escopos você concedeu.

Widgets

Três ferramentas anexam um widget interativo em hosts que oferecem suporte a MCP Apps (Claude — o Gemini não tem camada de widgets e sempre recebe o resultado em texto simples/JSON): preview_email (pré-visualização de e-mail ao vivo para desktop/celular), get_campaign_results (painel de resultados) e prepare_send (o cartão de confirmação de envio, cujo próprio botão Confirmar e enviar é o que de fato chama confirm_send).