> ## Documentation Index
> Fetch the complete documentation index at: https://help.scribe-mail.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Referência de ferramentas do Scribe MCP

> Todas as ferramentas que o servidor Scribe MCP expõe ao seu assistente de IA, agrupadas por área, com acesso de leitura, escrita e exclusão indicado.

Estas são as ferramentas que seu assistente de IA pode acionar depois de conectar o servidor MCP da Scribe. O servidor expõe 57 ferramentas em 15 áreas. Para conectar um assistente, consulte a [visão geral dos agentes de IA](/pt-BR/ai-agents).

<Note>
  **Como o acesso funciona**

  As ferramentas de leitura são executadas automaticamente e nunca alteram seus dados. As ferramentas de escrita (criar, atualizar, publicar e similares) pedem confirmação antes. As ferramentas de exclusão também pedem confirmação e são destrutivas. Toda ação fica restrita ao seu próprio espaço de trabalho.
</Note>

## Esquema

| Ferramenta           | Acesso  | O que faz                                                                                                                         |
| -------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `get_content_schema` | Leitura | Retorna o esquema de árvore de blocos da assinatura, todos os valores de enum e um exemplo prático. Chame antes de criar conteúdo |

## Assinaturas

| Ferramenta           | Acesso   | O que faz                                                                                             |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| `list_signatures`    | Leitura  | Lista os modelos de assinatura (árvores de blocos omitidas, a menos que você passe `include_content`) |
| `create_signature`   | Escrita  | Cria um modelo, em fase de preparação como `draft_content` até você publicar                          |
| `update_signature`   | Escrita  | Atualiza um modelo pelo id, em fase de preparação como rascunho até você publicar                     |
| `preview_signature`  | Leitura  | Renderiza um rascunho ou modelo publicado em HTML com valores de placeholder para conferir o layout   |
| `get_signature_html` | Leitura  | Obtém o HTML real instalado de uma assinatura publicada para um destinatário específico               |
| `publish_signature`  | Escrita  | Publica um modelo para que o rascunho fique no ar e seja instalado                                    |
| `install_signature`  | Escrita  | Instala o conteúdo no ar atual sem publicar                                                           |
| `delete_signature`   | Exclusão | Exclui um modelo e o desvincula dos membros da equipe                                                 |

## Variantes de assinatura

Uma variante é uma assinatura alternativa exibida em e-mails de resposta ou em e-mails internos (mesmo domínio). As variantes exigem uma integração ativa de assinaturas do Microsoft 365; sem ela, as escritas de variante retornam um 409 `variants_unavailable`.

| Ferramenta                  | Acesso   | O que faz                                                                                                   |
| --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| `list_signature_variants`   | Leitura  | Lista as variantes de resposta e internas de uma assinatura com seu estado e conteúdo                       |
| `update_signature_variant`  | Escrita  | Cria ou atualiza uma variante de resposta ou interna, em fase de preparação como rascunho até você publicar |
| `publish_signature_variant` | Escrita  | Publica uma variante para que o rascunho fique no ar e seja reimplantado                                    |
| `delete_signature_variant`  | Exclusão | Restaura uma variante para a assinatura principal (o registro é mantido)                                    |

## Destinatários da assinatura

| Ferramenta                            | Acesso  | O que faz                                                                    |
| ------------------------------------- | ------- | ---------------------------------------------------------------------------- |
| `list_signature_recipients`           | Leitura | Lista a quem uma assinatura está atribuída, com as regras de segmentação     |
| `add_signature_recipients`            | Escrita | Atribui uma assinatura a um lote de e-mails de membros da equipe             |
| `remove_signature_recipients`         | Escrita | Remove destinatários atribuídos manualmente de uma assinatura                |
| `set_signature_recipient_rules`       | Escrita | Define a atribuição automática e as regras de condição de Smartfield         |
| `add_signature_recipient_entities`    | Escrita | Segmenta uma assinatura para unidades organizacionais ou grupos do diretório |
| `remove_signature_recipient_entities` | Escrita | Remove a segmentação de unidades organizacionais ou grupos do diretório      |

## Membros da equipe

| Ferramenta        | Acesso   | O que faz                                                                       |
| ----------------- | -------- | ------------------------------------------------------------------------------- |
| `list_teammates`  | Leitura  | Lista membros da equipe com seus e-mails e valores de Smartfield                |
| `create_teammate` | Escrita  | Adiciona um membro da equipe a partir de um e-mail e valores de campo opcionais |
| `update_teammate` | Escrita  | Define os valores de Smartfield de um membro da equipe                          |
| `delete_teammate` | Exclusão | Exclui um membro da equipe de forma reversível                                  |

## E-mails

| Ferramenta     | Acesso   | O que faz                                                                             |
| -------------- | -------- | ------------------------------------------------------------------------------------- |
| `list_emails`  | Leitura  | Lista os e-mails dos membros da equipe (principal e aliases)                          |
| `create_email` | Escrita  | Adiciona um e-mail alias a um membro da equipe                                        |
| `update_email` | Escrita  | Altera um endereço de e-mail                                                          |
| `delete_email` | Exclusão | Exclui de forma reversível um e-mail alias (o e-mail principal não pode ser excluído) |

## Smartfields

| Ferramenta           | Acesso   | O que faz                                                                            |
| -------------------- | -------- | ------------------------------------------------------------------------------------ |
| `list_smart_fields`  | Leitura  | Lista as definições de Smartfield com tipo e fonte de dados                          |
| `create_smart_field` | Escrita  | Define um campo personalizado, opcionalmente sincronizado a partir de uma integração |
| `update_smart_field` | Escrita  | Atualiza um campo personalizado ou seu vínculo de integração                         |
| `delete_smart_field` | Exclusão | Exclui um campo personalizado e seus valores em todos os membros da equipe           |

## Pastas

| Ferramenta      | Acesso   | O que faz                                                    |
| --------------- | -------- | ------------------------------------------------------------ |
| `list_folders`  | Leitura  | Lista as pastas de assinaturas com a contagem de assinaturas |
| `create_folder` | Escrita  | Cria uma pasta para organizar modelos                        |
| `update_folder` | Escrita  | Renomeia uma pasta                                           |
| `delete_folder` | Exclusão | Exclui uma pasta (precisa estar vazia antes)                 |

## Recursos

| Ferramenta     | Acesso   | O que faz                                                                                 |
| -------------- | -------- | ----------------------------------------------------------------------------------------- |
| `list_assets`  | Leitura  | Lista a biblioteca de imagens (logos, banners, fotos)                                     |
| `create_asset` | Escrita  | Faz upload de uma imagem a partir de base64 ou de uma URL de origem                       |
| `update_asset` | Escrita  | Atualiza o nome ou a função de um recurso                                                 |
| `delete_asset` | Exclusão | Exclui um recurso (recursos em uso têm exclusão lógica para continuar sendo renderizados) |

## Integrações

| Ferramenta                  | Acesso  | O que faz                                                                                 |
| --------------------------- | ------- | ----------------------------------------------------------------------------------------- |
| `list_integrations`         | Leitura | Lista as integrações ativas com status e detalhes de erros                                |
| `list_integration_entities` | Leitura | Lista as unidades organizacionais e os grupos do diretório para direcionar uma assinatura |

## Documentos financeiros

| Ferramenta                 | Acesso  | O que faz                                                       |
| -------------------------- | ------- | --------------------------------------------------------------- |
| `list_financial_documents` | Leitura | Lista faturas e notas de crédito com links de PDF para download |

## Espaço de trabalho

| Ferramenta      | Acesso  | O que faz                                                                       |
| --------------- | ------- | ------------------------------------------------------------------------------- |
| `get_workspace` | Leitura | Lê o plano do espaço de trabalho, o status e a quantidade de usuários faturados |

## Análise

Não existe um campo de taxa de cliques. Combine `get_analytics_views` com `get_analytics_clicks` e calcule cliques divididos por visualizações.

| Ferramenta                     | Acesso  | O que faz                                                                             |
| ------------------------------ | ------- | ------------------------------------------------------------------------------------- |
| `get_analytics_views`          | Leitura | Visualizações de assinaturas em um intervalo de datas, como série temporal ou ranking |
| `get_analytics_clicks`         | Leitura | Cliques em assinaturas em um intervalo de datas, como série temporal ou ranking       |
| `get_analytics_events_summary` | Leitura | Números agregados de conversão e receita, como série temporal ou ranking              |
| `list_analytics_events`        | Leitura | Lista os eventos de conversão brutos registrados por trás da análise                  |

## Visitantes

Visitantes são os usuários finais identificados do próprio espaço de trabalho (a partir de chamadas `identify`), não os membros da equipe da Scribe.

| Ferramenta              | Acesso  | O que faz                                                                                 |
| ----------------------- | ------- | ----------------------------------------------------------------------------------------- |
| `list_visitors`         | Leitura | Lista visitantes identificados com atributos e atribuição de primeiro contato             |
| `get_visitor`           | Leitura | Obtém um visitante identificado com atributos, atribuição e engajamento ao longo do tempo |
| `get_visitor_breakdown` | Leitura | Classifica qual assinatura ou membro da equipe captou mais visitantes identificados       |

## Campanhas de marketing

| Ferramenta                    | Acesso   | O que faz                                                     |
| ----------------------------- | -------- | ------------------------------------------------------------- |
| `list_marketing_campaigns`    | Leitura  | Lista campanhas com status, segmentação e conteúdo            |
| `create_marketing_campaign`   | Escrita  | Cria um rascunho de campanha com nome e janela de tempo       |
| `update_marketing_campaign`   | Escrita  | Atualiza uma campanha pelo id                                 |
| `schedule_marketing_campaign` | Escrita  | Ativa ou agenda uma campanha em rascunho ou pausada           |
| `pause_marketing_campaign`    | Escrita  | Pausa uma campanha ativa                                      |
| `resume_marketing_campaign`   | Escrita  | Retoma uma campanha pausada                                   |
| `delete_marketing_campaign`   | Exclusão | Exclui uma campanha (uma campanha ativa é interrompida antes) |

## Conecte seu assistente

Vamos conectar? Siga as etapas específicas de cada assistente na [visão geral dos agentes de IA](/pt-BR/ai-agents).
