MCP Server Integration
O ChatReact implementa o Model Context Protocol (MCP), permitindo que você conecte sua conta ChatReact a assistentes de IA como Claude Desktop, Cursor e outras ferramentas compatíveis com MCP.
O que é MCP?
O Model Context Protocol é um padrão aberto que permite que assistentes de IA interajam com serviços e fontes de dados externas. Com a integração MCP do ChatReact, você pode:
- Gerenciar chatbots — criar, configurar (persona, idiomas, widget, comportamento, restrições), incorporar e excluir chatbots
- Construir a base de conhecimento — adicionar documentos, rastrear sites, gerenciar páginas rastreadas e instruções principais
- Gerenciar FAQs — FAQs, categorias, sugestões, traduções e o widget de FAQ
- Revisar conversas — avaliar conversas, atribuir categorias de confiança, executar o Improvement Agent
- Trabalhar com leads e formulários — leads, categorias de leads, configurações de captura, formulários de contato e envios
- Atuar como agente de chat ao vivo — definir sua disponibilidade, assumir conversas em espera, responder e encerrar sessões
- Administrar sua empresa — perfil, cores da marca, membros da equipe e convites
- Usar o Email Assistant — conexões de caixa de correio, categorias, contatos e atividade
- Ler análises e notificações
Tudo o que você pode fazer no painel está disponível via MCP (e pela REST API); apenas ações vinculadas ao navegador, como pagamentos, OAuth de caixa de correio, passkeys, exclusão de conta e gerenciamento de chaves de API permanecem no painel.
Começando
1. Gere uma Chave de API
- Navegue até seu Painel → Empresa → API aba
- Clique em Criar Chave de API
- Dê à sua chave um nome descritivo (por exemplo, "Claude Desktop") e selecione pelo menos uma permissão
- Copie a chave gerada (começa com
cr_)
Chaves de API estão disponíveis em planos pagos — veja nossa página de Preços.
Armazene sua chave de API com segurança. Ela não pode ser recuperada após a criação.
2. Configure seu Cliente MCP
O servidor MCP do ChatReact é hospedado em https://www.chatreact.ai/api/mcp e se comunica via HTTP (JSON-RPC). Autentique com um cabeçalho Authorization: Bearer — um cabeçalho X-API-Key com a mesma chave também é aceito.
Cursor IDE
O Cursor suporta servidores MCP remotos diretamente. Adicione às suas configurações MCP do Cursor:
{
"mcpServers": {
"chatreact": {
"url": "https://www.chatreact.ai/api/mcp",
"headers": {
"Authorization": "Bearer cr_your_api_key_here"
}
}
}
}
Claude Desktop
O arquivo de configuração do Claude Desktop suporta servidores baseados em comando, então use a ponte padrão mcp-remote para conectar ao endpoint hospedado:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"chatreact": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://www.chatreact.ai/api/mcp",
"--header",
"X-API-Key:cr_your_api_key_here"
]
}
}
}
Essa configuração requer Node.js instalado. O exemplo usa o cabeçalho X-API-Key porque alguns clientes não lidam bem com espaços em argumentos.
3. Reinicie seu Assistente de IA
Após salvar a configuração, reinicie o Claude Desktop ou o Cursor para estabelecer a conexão.
Ferramentas Disponíveis
O MCP do ChatReact expõe as ferramentas abaixo, agrupadas por área. A coluna Scope mostra a permissão de chave de API que uma ferramenta requer (any = toda chave válida). As ferramentas são executadas com as mesmas permissões aplicáveis, limites de plano e efeitos colaterais das operações suportadas no painel. Fluxos vinculados ao navegador como pagamento, autorização de caixa de correio, passkey, exclusão de conta e gerenciamento de chaves permanecem no painel.
Ferramentas destrutivas (excluir, resetar, fechar, mesclar) pedem confirmação quando usadas através do Dashboard Assistant. Via chave de API, elas executam imediatamente.
Conta
| Tool | Description | Scope |
|---|---|---|
account_usage_get | Obter o plano atual (tier, status), os contadores de uso do período de faturamento atual (empresas, chatbots, membros da equipe, conversas, tokens) e os limites do plano, além dos limites efetivos e flags de recurso da empresa ao qual a chamada está associada. | any |
user_companies | Listar todas as empresas às quais o usuário atual tem acesso, com a função do usuário em cada uma. | any |
user_notification_mark_read | Marcar uma das notificações do usuário atual como lida. | any |
user_notification_preferences_get | Obter as preferências de notificação do usuário atual: alternadores globais email/push, frequência/hora/dia da semana/timezone do resumo, horas silenciosas e configurações de canal por tipo. | any |
user_notification_preferences_update | Atualizar as preferências globais de notificação do usuário atual (alternadores email/push, agenda de resumos, horas silenciosas). | any |
user_notification_type_setting_update | Habilitar ou desabilitar entrega por email/in-app para um único tipo de notificação do usuário atual (por exemplo | any |
user_notification_types_list | Listar todos os tipos de notificação agrupados por categoria (chatbot, leads, live chat, knowledge, team, billing). | any |
user_notification_unread_count | Obter o número de notificações não lidas do usuário atual. | any |
user_notifications | Listar as notificações do usuário atual, mais novas primeiro, com paginação cursor. | any |
user_notifications_delete_old | Manutenção: excluir permanentemente as notificações do usuário atual que já foram lidas e têm mais de 30 dias. | any |
user_notifications_mark_all_read | Marcar todas as notificações do usuário atual como lidas. | any |
user_profile | Obter o perfil do usuário atual (id, nome, email, função, nível de assinatura). | any |
Empresa & Equipe
| Tool | Description | Scope |
|---|---|---|
company_chatbots_list | Listar todos os chatbots de uma empresa específica com estatísticas resumidas. | chatbots:read |
company_get | Obter informações detalhadas sobre uma empresa: perfil, proprietário, configurações de marca (cores, email de notificação) e contagens. | any |
company_invite_cancel | Cancelar (excluir) um convite de equipe para que o link deixe de funcionar. | company:write |
company_invite_resend | Reenviar um convite de equipe pendente: emite um novo token, estende a expiração em 7 dias e envia o email novamente. | company:write |
company_invites_list | Listar convites de equipe de uma empresa (pendentes por padrão; defina includeExpired para também retornar os expirados). | company:read |
company_list | Listar todas as empresas às quais o usuário tem acesso (chaves de API e o Dashboard Assistant só veem sua própria empresa). | any |
company_logo_remove | Remover o logotipo da empresa (exclui a imagem armazenada e limpa a URL do logo). | company:write |
company_member_invite | Convidar um membro da equipe por email com uma função (ADMIN, MANAGER, AGENT ou VIEWER). | company:write |
company_member_remove | Remover um membro da equipe da empresa. | company:write |
company_member_update_role | Alterar a função de um membro da equipe (ADMIN, MANAGER, AGENT ou VIEWER). | company:write |
company_members_list | Listar os membros de uma empresa com suas funções (OWNER, ADMIN, MANAGER, AGENT, VIEWER). | any |
company_settings_update | Atualizar configurações de marca da empresa: primaryColor / secondaryColor (#RRGGBB) e o notificationEmail para revisões de chat. | company:write |
company_update | Atualizar o perfil da empresa: nome (2-100 chars), descrição (máx. 1000 chars) ou website (https:// é adicionado automaticamente; passe uma string vazia para limpar website/descrição). | company:write |
Gestão de Chatbot
| Tool | Description | Scope |
|---|---|---|
chatbot_add_instruction | Adicionar uma nova instrução principal a um chatbot (1-5000 chars). | chatbots:write |
chatbot_confirm_embed | Marcar um chatbot como incorporado no site (oculta o lembrete de configuração no painel). | chatbots:write |
chatbot_create | Criar um novo chatbot (mesmo que o assistente de criação do painel). | chatbots:write |
chatbot_delete | Excluir permanentemente um chatbot com todas as suas FAQs, documentos, conversas, leads e formulários (não pode ser desfeito). | chatbots:write |
chatbot_delete_instruction | Excluir uma instrução principal de um chatbot. | chatbots:write |
chatbot_get | Obter informações detalhadas sobre um chatbot: configurações gerais, personalidade (persona, tonalidade, idiomas, restrições), configurações do widget, live chat, fase de aprendizado, status de incorporação e contagens. | chatbots:read |
chatbot_get_embed_code | Obter o snippet HTML para instalar um chatbot em um site (URL do script + tag <script>) e se a incorporação foi confirmada. | chatbots:read |
chatbot_get_instructions | Obter todas as instruções principais de um chatbot. | chatbots:read |
chatbot_improve_instructions | Reescrever o texto da instrução principal com o aprimorador de IA da plataforma (mesmo que "Improve with AI" do painel). | chatbots:write |
chatbot_learning_phase_get | Obter as configurações da fase de aprendizado de um chatbot: preset de comportamento (CAUTIOUS, BALANCED, CONFIDENT), prompt customizado e se o bot ainda está em fase de aprendizado. | chatbots:read |
chatbot_learning_phase_update | Definir o preset de comportamento da fase de aprendizado (CAUTIOUS = referir a humano quando incerto, BALANCED, CONFIDENT) e/ou um prompt customizado para a fase de aprendizado. | chatbots:write |
chatbot_list | Listar todos os chatbots aos quais o usuário tem acesso, com estatísticas resumidas. | chatbots:read |
chatbot_reorder_instructions | Definir a ordem das instruções principais de um chatbot. | chatbots:write |
chatbot_templates_list | Listar os templates de chatbot (presets para persona, tonalidade, mensagens e comportamento do widget) que podem ser passados como templateId para chatbot_create, e se o plano da empresa pode usá-los. | chatbots:read |
chatbot_toggle_active | Ativar ou desativar um chatbot. | chatbots:write |
chatbot_toggle_learning | Encerrar (false) ou reativar (true) a fase de aprendizado de um chatbot. | chatbots:write |
chatbot_update | Atualizar as configurações gerais de um chatbot: nome, descrição, isActive, live chat (liveChatEnabled/liveChatMode, recurso do plano), showBranding (planos white-label), emails de revisão de chat, geração automática de FAQ, texto legado de coreInstructions, fase de aprendizado (isInLearningPhase, learningPhaseBehavior, learningPhaseCustomPrompt). | chatbots:write |
chatbot_update_instruction | Atualizar uma instrução principal existente (content, isActive, channel, sortOrder). | chatbots:write |
chatbot_update_personality | Atualizar a personalidade de um chatbot: persona (usePersonaName, personaName, personaRole, personaBackground, communicationStyle), sliders de tonalidade 1-5, idiomas (primaryLanguage, supportedLanguages, technicalLevel, timezone, formalAddress, speakAsCompany), mensagens (welcomeMessage, fallbackMessage, proactive greeting) e restrições (blacklistTopics, complianceRules, maxResponseLength, human handoff). | chatbots:write |
widget_settings_get | Obter as configurações atuais do widget de um chatbot (toda aparência, branding, comportamento e campos do formulário pré-chat). | chatbots:read |
widget_settings_update | Atualizar o widget de chat de um chatbot: posição (incl. | chatbots:write |
widget_translations_get | Obter as traduções do widget por idioma de um chatbot: { '<lang>': { welcomeMessage, fallbackMessage, headerTitle, headerSubtitle, bubbleText } }. | chatbots:read |
widget_translations_update | Definir traduções do widget por idioma. | chatbots:write |
Base de Conhecimento
| Tool | Description | Scope |
|---|---|---|
crawler_job_cancel | Cancelar um trabalho de rastreamento PENDING ou RUNNING; as páginas restantes são ignoradas. | knowledge:write |
crawler_job_get | Obter o status de um trabalho de rastreamento, progresso (pagesCrawled/pagesFound, tokensUsed) e o status de cada página. | knowledge:read |
crawler_jobs_list | Listar os trabalhos de rastreamento de um chatbot (mais recentes primeiro) com status e progresso. | knowledge:read |
crawler_limits | Obter os limites de rastreamento do plano para um chatbot (máx. de páginas por rastreamento, tokens por página, rastreamentos por mês) e se um novo rastreamento pode ser iniciado neste mês. | knowledge:read |
crawler_preview_scan | Escanear um site e listar suas páginas rastreáveis (url, title, isRecommended) sem importar nada. | knowledge:write |
crawler_start | Iniciar um trabalho de rastreamento que importa as URLs selecionadas para a base de conhecimento do chatbot (processado em segundo plano; poll crawler_job_get). | knowledge:write |
knowledge_document_add_from_url | Baixar um documento (PDF, TXT, MD, CSV, JSON, DOCX; máx. 10 MB) de uma URL pública http(s) e adicioná-lo à base de conhecimento de um chatbot. | knowledge:write |
knowledge_document_add_text | Adicionar um documento de texto ou markdown à base de conhecimento de um chatbot a partir de conteúdo inline (máx. 10 MB). | knowledge:write |
knowledge_document_delete | Excluir um documento carregado da base de conhecimento. | knowledge:write |
knowledge_document_get | Obter detalhes de um documento carregado incluindo status de processamento, mensagem de erro e uma URL de download de curta duração. | knowledge:read |
knowledge_documents_list | Listar os documentos carregados (PDF, TXT, MD, CSV, JSON, DOCX) na base de conhecimento de um chatbot com status e tamanho. | knowledge:read |
knowledge_page_add | Rastrear uma única URL e adicioná-la à base de conhecimento do chatbot (falha com CONFLICT quando a URL já estiver indexada, FORBIDDEN quando o limite de tokens for atingido). | knowledge:write |
knowledge_page_delete | Excluir uma página rastreada da base de conhecimento (remove seu arquivo de vector-store). | knowledge:write |
knowledge_page_get | Obter uma página rastreada incluindo o conteúdo em markdown que foi indexado para o chatbot (útil para verificar o que o bot sabe sobre uma página). | knowledge:read |
knowledge_page_recrawl | Buscar novamente uma página rastreada e substituir seu conteúdo indexado (por exemplo | knowledge:write |
knowledge_pages_delete | Excluir várias páginas rastreadas de um chatbot de uma vez. | knowledge:write |
knowledge_pages_list | Listar páginas rastreadas na base de conhecimento de um chatbot, opcionalmente filtradas por domínio, status ou termo de busca (URL/title). | knowledge:read |
knowledge_stats | Visão geral da base de conhecimento de um chatbot: documentos (por status, tamanho), páginas rastreadas e sites (por status), trabalhos de rastreamento, instruções principais divididas por origem (manual vs improvement agent), FAQs, status/tamanho do vector store e uso de armazenamento vs. | knowledge:read |
knowledge_website_delete | Excluir todas as páginas rastreadas de um site (domínio) da base de conhecimento do chatbot. | knowledge:write |
knowledge_website_recrawl | Re-rastrear todas as páginas de um site (domínio) na base de conhecimento do chatbot para atualizar seu conteúdo. | knowledge:write |
knowledge_website_recrawl_cancel | Cancelar um re-rastreamento de site em andamento: páginas enfileiradas (PENDING) do domínio são revertidas ao seu estado indexado anterior. | knowledge:write |
knowledge_websites_list | Listar os sites (domínios) cujas páginas estão na base de conhecimento de um chatbot, com contagens de páginas por status e totais de tokens. | knowledge:read |
Gestão de Preços
Essas ferramentas gerenciam rascunhos de preços estruturados e aprovações explícitas. Salvar um rascunho é separado de aprovar a versão exata; elegibilidade também depende de status e validade. Chaves de API existentes não ganham permissões de preço automaticamente. Apenas o proprietário da empresa pode conceder prices:write ou prices:approve. Chamadas por chave de API executam diretamente, então revise a entrada exata antes de chamar uma mutação. Veja Prices & services para o fluxo de trabalho do cliente.
| Tool | Description | Scope |
|---|---|---|
price_list | Paginar cabeçalhos de preço e separar elegibilidade da versão aprovada. | prices:read |
price_get | Ler o estado completo do item e revisões. | prices:read |
price_detail | Ler detalhe do item com histórico de revisões paginado. | prices:read |
price_suggestions_list | Paginar sugestões de preço. | prices:read |
price_create | Criar um rascunho com um ID de item gerado pelo servidor. | prices:write |
price_edit | Criar um novo rascunho a partir de uma versão de item explicitamente esperada. | prices:write |
price_import_csv | Importar rascunhos com um formato explícito e ID de importação estável para tentativas seguras. | prices:write |
price_suggestion_apply | Aplicar o candidato de sugestão selecionado como rascunho. | prices:write |
price_approve | Aprovar uma versão de item explicitamente esperada. | prices:approve |
price_approve_many | Aprovar seleção de ID/versão explicitamente esperada de forma atômica; qualquer versão desatualizada rejeita toda a seleção. | prices:approve |
price_archive | Arquivar um item em sua versão explicitamente esperada. | prices:approve |
Edições de rascunho preservam a revisão aprovada anterior. Formato CSV e separador decimal devem ser explícitos; conteúdo CSV alterado requer um novo import ID. Todas as operações estão vinculadas à empresa da chave de API e ao chatbot especificado.
Gestão de FAQ
| Tool | Description | Scope |
|---|---|---|
faq_cache_purge | Limpar os dados em cache do widget de FAQ em todos os sites CMS conectados (plugin WordPress). | faqs:write |
faq_categories_list | Listar as categorias de FAQ de um chatbot com suas contagens de FAQ, slugs, modo de ordenação e traduções. | faqs:read |
faq_categories_reorder | Definir a ordem das categorias de FAQ no widget: posição em categoryIds vira sortOrder. | faqs:write |
faq_category_create | Criar uma categoria de FAQ para um chatbot (slug é gerado a partir do nome). | faqs:write |
faq_category_delete | Excluir uma categoria de FAQ. | faqs:write |
faq_category_translations_update | Substituir as traduções de uma categoria de FAQ, por exemplo | faqs:write |
faq_category_update | Renomear uma categoria de FAQ ou alterar sua descrição, ícone ou modo de ordenação. | faqs:write |
faq_create | Criar uma FAQ para um chatbot. | faqs:write |
faq_delete | Excluir permanentemente uma FAQ (também a remove da base de conhecimento do chatbot e purga caches do widget CMS). | faqs:write |
faq_embed_code_get | Obter os snippets de incorporação do widget de FAQ: tag script, shortcode do WordPress e snippet Shopify Liquid, além de variantes por categoria (use categorySlug de faq_categories_list para incorporar apenas uma categoria). | chatbots:read |
faq_get | Obter os detalhes completos de uma FAQ: pergunta, resposta, categoria, estado de publicação, ordem, traduções, campos de SEO e estatísticas de feedback. | faqs:read |
faq_list | Listar FAQs de um chatbot (use chatbot_list para encontrar o chatbotId). | faqs:read |
faq_reorder | Definir a ordem de exibição das FAQs no widget. | faqs:write |
faq_suggestion_approve | Aprovar uma sugestão de FAQ PENDING: cria uma FAQ publicada (opcionalmente com pergunta/resposta/categoria editadas) e marca a sugestão como APPROVED. | faqs:write |
faq_suggestion_get | Obter os detalhes completos de uma sugestão de FAQ (resposta completa, raciocínio da IA, categoria sugerida, estado de revisão). | faqs:read |
faq_suggestion_reject | Rejeitar uma sugestão de FAQ PENDING com uma razão opcional. | faqs:write |
faq_suggestions_generate | Permitir que a IA proponha novas FAQs a partir da base de conhecimento do chatbot (páginas rastreadas / documentos carregados), opcionalmente para uma categoria. | faqs:write |
faq_suggestions_list | Listar sugestões de FAQ geradas por IA de um chatbot (a partir de conversas de chat ou faq_suggestions_generate). | faqs:read |
faq_translate | Traduzir a pergunta e resposta de uma FAQ com IA para os outros idiomas suportados do chatbot (ou os targetLanguages fornecidos) e salvar o resultado. | faqs:write |
faq_translations_update | Salvar traduções de uma FAQ por idioma, por exemplo | faqs:write |
faq_update | Atualizar a pergunta, resposta, categoria, estado de publicação ou ordem manual de uma FAQ. | faqs:write |
faq_widget_settings_get | Obter as configurações de aparência e comportamento do widget de FAQ incorporável (cores, border radius, título, espaçamento, max width, allowMultipleOpen, autoOpenFirst, sort mode, traduções de título). | chatbots:read |
faq_widget_settings_update | Atualizar as configurações do widget de FAQ: cores (hex), borderRadius 0-32, título (máx. 100) + showTitle, spacing compact|normal|relaxed, maxWidth 0-2000 (0 = largura total), allowMultipleOpen, autoOpenFirst, sortMode custom|date|name e traduções de título por idioma. | chatbots:write |
Histórico de Chat & Feedback
| Tool | Description | Scope |
|---|---|---|
chat_feedback_dismiss | Marcar um chat como revisado sem avaliá-lo (remove da fila pendente, não altera a pontuação de confiança). | chats:write |
chat_feedback_get | Obter uma revisão de chat (feedback) com análise de IA, severidade, categoria de confiança, mudança de pontuação e a sessão de melhoria vinculada. | chats:read |
chat_feedback_list | Listar revisões de chat (linhas de feedback) de um chatbot com filtro de status e contagens. | chats:read |
chat_feedback_set_severity | Substituir a classificação de severidade (MINOR|MODERATE|MAJOR|CRITICAL) de um chat negativo revisado; a severidade pondera a queda da pontuação de confiança. | chats:write |
chat_feedback_stats | Contagens de sessões por bucket de revisão para um chatbot (total, none, pending, positive, negative, reviewed, improved) — os cards de estatísticas da página de chats do painel. | chats:read |
chat_feedback_submit | Avaliar uma sessão de chat como Good (isPositive=true) ou Needs Work (isPositive=false). | chats:write |
chat_session_get | Obter uma sessão de chat com a transcrição completa (por mensagem token/model/latency/pageUrl), detalhes do visitante, URL da página inicial, categoria de confiança, feedback (severidade, análise IA, sessão de melhoria vinculada) e tags. | chats:read |
chat_session_search | Buscar sessões de chat de um chatbot por conteúdo de mensagem e/ou email do visitante. | chats:read |
chat_session_set_category | Atribuir ou alterar a categoria de confiança de uma sessão de chat (corrige a categorização da IA; a confiança por categoria é recalculada quando o chat foi revisado). | chats:write |
chat_sessions_list | Listar sessões de chat de um chatbot, mais recentes primeiro, com os mesmos filtros da fila de revisão da página de chats do painel. | chats:read |
Improvement Agent
| Tool | Description | Scope |
|---|---|---|
confidence_categories_list | Listar as categorias de confiança de um chatbot com pontuação de confiança por categoria, contagem de revisões e frequência de email de revisão. | chats:read |
confidence_category_create | Criar uma categoria de confiança para um chatbot. | chatbots:write |
confidence_category_delete | Excluir uma categoria de confiança. | chatbots:write |
confidence_category_merge | Mesclar uma categoria de confiança em outra do mesmo chatbot: todos os chats/revisões movem-se para o alvo, a origem é excluída e as pontuações são recalculadas. | chatbots:write |
confidence_category_update | Renomear uma categoria de confiança e/ou definir sua frequência de email de revisão (EVERY|HOURLY|DAILY|WEEKLY|NEVER; emailFrequencyHours 1-24 apenas para HOURLY). | chatbots:write |
confidence_status_get | Status de confiança de um chatbot: pontuação, threshold de graduação, flag de fase de aprendizado, comportamento da fase de aprendizado (CAUTIOUS|BALANCED|CONFIDENT) e prompt customizado, contagens de revisão e pontuações por categoria. | analytics:read |
improvement_proposal_approve | Aprovar uma proposta de melhoria PENDING e aplicar a alteração ao chatbot (adição/atualização de instrução principal, criação/atualização de FAQ ou atualização de persona) — mesma lógica e limites de plano do painel. | chatbots:write |
improvement_proposal_reject | Rejeitar uma proposta de melhoria PENDING. | chatbots:write |
improvement_proposal_simulate | Simular como o chatbot responderia à mensagem problemática com uma proposta aplicada (original vs. | chatbots:write |
improvement_proposals_pending | Listar propostas de melhoria aguardando revisão (status PENDING) na empresa ou para um chatbot. | chatbots:read |
improvement_session_complete | Marcar uma sessão de melhoria como COMPLETED (o chat então conta como Improved na fila de revisão). | chatbots:write |
improvement_session_create | Abrir o Improvement Agent para um chat avaliado como Needs Work. | chatbots:write |
improvement_session_get | Obter uma sessão de melhoria com o chat original (mensagens têm índice 1-based utilizável como targetMessageIndex), a conversa do agente, todas as propostas (com sua última simulação) e simulações. | chatbots:read |
improvement_session_reset | Reiniciar uma sessão de melhoria: exclui todas as mensagens do agente, simulações e propostas PENDING/REJECTED (as aplicadas são mantidas) e inicia uma conversa nova. | chatbots:write |
improvement_session_send_message | Enviar uma mensagem ao Improvement Agent (descrever o que estava errado na resposta do bot; opcionalmente targetMessageIndex = índice 1-based da mensagem do bot em originalChat.messages). | chatbots:write |
improvement_sessions_list | Listar sessões de melhoria (conversas do Improvement Agent iniciadas a partir de revisões negativas) para um chatbot ou para a empresa inteira, mais recentes primeiro, com contagens de propostas. | chatbots:read |
improvement_simulation_assess | Avaliar um resultado de simulação: isApproved=true quando a resposta simulada é boa (a proposta pode então ser aplicada), false quando precisa de mais trabalho (comentário 'almost' = quase correta). | chatbots:write |
Live Chat
| Tool | Description | Scope |
|---|---|---|
live_chat_agents_available | Obter a disponibilidade de live chat do próprio usuário atual, os agentes atualmente disponíveis para live chat (heartbeat recente, o mesmo sinal usado pelo widget) e se o plano da empresa inclui live chat. | chats:read |
live_chat_heartbeat | Atualizar o heartbeat de presença de live chat do usuário atual (somente enquanto marcado como disponível via live_chat_set_availability). | chats:write |
live_chat_message_send | Enviar uma mensagem ao visitante como o agente designado. | chats:write |
live_chat_queue | Obter a fila de live chat: sessões aguardando um agente, mais antigas primeiro (FIFO). | chats:read |
live_chat_session_assign | Assumir uma sessão de live chat WAITING da fila: atribui ao usuário atual (proprietário da empresa para chaves de API) e notifica o visitante que o agente entrou. | chats:write |
live_chat_session_close | Encerrar uma sessão de live chat como agente (qualquer membro da empresa que não seja VIEWER). | chats:write |
live_chat_session_get | Obter uma sessão de live chat com info do visitante, agente atribuído, todas as mensagens e a conversa anterior do bot (contexto do handoff). | chats:read |
live_chat_sessions_list | Listar sessões de live chat (mais recentes primeiro; sessões WAITING mais antigas primeiro) com filtros opcionais por chatbot, status e agente atribuído. | chats:read |
live_chat_set_availability | Alternar o switch 'Available for Live Chat' do usuário atual para uma empresa. | chats:write |
Leads
| Tool | Description | Scope |
|---|---|---|
lead_assign | Atribuir um lead a um membro da empresa ou desatribuir (assignedToId: null). | leads:write |
lead_bulk_update_status | Definir o status de vários leads (máx. 100) de uma vez. | leads:write |
lead_categories_list | Listar as categorias de lead de um chatbot com contagens de lead e membros da equipe notificados por categoria. | leads:read |
lead_category_assign_user | Adicionar um membro da empresa à lista de notificações de uma categoria de lead (ou atualizar suas flags de notificação). | leads:write |
lead_category_create | Criar uma categoria de lead para um chatbot. | leads:write |
lead_category_delete | Excluir uma categoria de lead. | leads:write |
lead_category_remove_user | Remover um membro da empresa da lista de notificações de uma categoria de lead. | leads:write |
lead_category_update | Atualizar o nome, descrição e/ou cor de uma categoria de lead. | leads:write |
lead_create | Criar um lead manualmente (por exemplo | leads:write |
lead_delete | Excluir um lead permanentemente. | leads:write |
lead_field_config_get | Obter a configuração de captura de leads de um chatbot: campos (ids mapear para chaves em lead.data), mensagem de confirmação, traduções de campo/UI e configurações de reconhecimento por IA. | leads:read |
lead_field_config_update | Atualizar a configuração de captura de leads de um chatbot. | leads:write |
lead_get | Obter detalhes completos de um lead incluindo responsável, categoria e a transcrição da conversa fonte (paginada com messageOffset/messageLimit, padrão primeiras 20 mensagens). | leads:read |
lead_list | Listar leads de um chatbot (mais recentes primeiro) com filtros opcionais por status, categoria, responsável e busca por texto livre (nome/email/empresa). | leads:read |
lead_stats | Obter estatísticas de leads para um chatbot: contagens por status, leads dos últimos 7 dias e a taxa de conversão (percentual). | leads:read |
lead_update | Atualizar o status, categoria, notas, dados capturados e/ou responsável de um lead. | leads:write |
Formulários
| Tool | Description | Scope |
|---|---|---|
form_create | Criar um formulário de contato para um chatbot (básicos, campos, design e configurações anti-spam em uma única chamada). | forms:write |
form_delete | Excluir permanentemente um formulário de contato e TODOS os seus envios (cascade). | forms:write |
form_get | Obter um formulário de contato completo: campos, traduções, styling, configurações de spam, estado ativo, contagem de envios e o embed script tag (embedCode). | forms:read |
form_list | Listar os formulários de contato de um chatbot com contagens de campos, contagens de envios e códigos de incorporação. | forms:read |
form_stats | Contagens de envios de um formulário de contato: total, pending, approved, spam e rejected. | forms:read |
form_submission_delete | Excluir permanentemente um envio de formulário de contato (por exemplo | forms:write |
form_submission_get | Obter um envio de formulário de contato completo: dados dos campos submetidos, pontuação de spam e análise de spam por IA, metadados IP/user agent/referrer e informações de revisão. | forms:read |
form_submission_update_status | Revisar um envio de formulário de contato: definir seu status para APPROVED, SPAM ou REJECTED com uma nota de revisão opcional. | forms:write |
form_submissions_list | Listar envios de um formulário de contato, mais recentes primeiro, opcionalmente filtrados por status (PENDING, APPROVED, SPAM, REJECTED) e data de criação. | forms:read |
form_update | Atualizar um formulário de contato: nome, descrição, estado ativo (isActive controla se o embed é renderizado), campos (substituição completa), design (cores, texto do botão, mensagem de sucesso) e configurações de spam (spamThreshold, autoRejectSpam, notificationEmail). | forms:write |
form_update_translations | Substituir as traduções de campo e/ou UI de um formulário de contato. | forms:write |
Email Assistant
| Tool | Description | Scope |
|---|---|---|
email_activity_list | Listar o log de atividade de emails processados de uma conexão de caixa de correio (mais recentes primeiro): remetente, assunto, categoria atribuída, resultado (CATEGORIZED, DRAFT_CREATED, SKIPPED_NO_RULE, SKIPPED_NO_KNOWLEDGE, SKIPPED_BY_TRIAGE, SKIPPED_QUOTA, ERROR) e outcomeDetail. | email:read |
email_categories_list | Listar as categorias de email de uma conexão de caixa de correio (ordenadas por sortOrder). | email:read |
email_category_create | Criar uma categoria de email para uma conexão de caixa de correio (máx. 20 por conexão). | email:write |
email_category_delete | Excluir uma categoria de email. | email:write |
email_category_update | Atualizar uma categoria de email (parcial: somente os campos fornecidos mudam). | email:write |
email_connection_disconnect | Desconectar uma caixa de correio permanentemente. | email:write |
email_connection_get | Obter uma conexão de caixa de correio incl. | email:read |
email_connection_update | Atualizar uma conexão de caixa de correio: pausar/resumir a sincronização (paused true/false; apenas alterna ACTIVE<->DISABLED, nunca sobrescreve TOKEN_EXPIRED/ERROR), alternar rascunho de resposta (draftingEnabled) e categorização/organização (organizingEnabled), apontar o chatbot que fornece (chatbotId da mesma empresa) ou definir a assinatura HTML da resposta (signatureHtml, máx. 20000 chars; string vazia limpa). | email:write |
email_connections_list | Listar as conexões de caixa de correio do Email Assistant da empresa (endereço, status ACTIVE/DISABLED/TOKEN_EXPIRED/ERROR, última sincronização, último erro, alternadores drafting/organizing, chatbot responsável, draftReadyCategoryCount = categorias que podem gerar rascunhos, baseRuleCount = regras "Chat + Email" aplicadas a todos os rascunhos) junto com os limites do plano (emailAssistantEnabled, maxMailboxConnections, emailDraftsPerMonth). | email:read |
email_contact_delete | Excluir um contato de email aprendido (esquecer o perfil do remetente, por exemplo | email:write |
email_contact_get | Obter um contato de email aprendido com todos os fatos aprendidos, notas internas, relacionamento, configuração de tratamento formal/informal e estatísticas de email. | email:read |
email_contact_update | Atualizar um contato de email aprendido. | email:write |
email_contacts_list | Listar os contatos de email aprendidos da empresa (email mais recente primeiro) com relacionamento, tratamento formal/informal (formalAddress: true = formal 'Sie', false = informal 'Du', null = automático), contagem de fatos e pré-visualização de notas. | email:read |
email_folder_create | Criar uma pasta de correio embaixo da caixa de entrada (retorna a existente se o nome estiver em uso) para usar como destino de movimentação de categoria. | email:write |
email_folders_list | Listar as pastas para as quais uma categoria de email pode mover mensagens, ao vivo a partir da caixa de correio: subpastas da inbox, pastas top-level customizadas, archive, junk e trash (id 'deleteditems'). | email:read |
email_general_rules_list | Listar as regras de chatbot que se aplicam a todo rascunho de resposta de uma caixa: instruções principais ativas com channel BOTH ("Chat + Email"), além das legadas só-por-email ainda não migradas para uma categoria. | email:read |
Analytics
| Tool | Description | Scope |
|---|---|---|
analytics_chat_volume | Volume de chats (sessões iniciadas) ao longo do tempo para gráficos e tendências: período week/month/quarter/year, granularidade hour/day/week/month, opcionalmente para um chatbot. | analytics:read |
analytics_chatbot_stats | Performance por chatbot de uma empresa em uma única chamada (a tabela de desempenho de chatbots do painel): id, nome, slug, isActive, sessões, mensagens, FAQs e leads por chatbot, ordenados por sessões. | analytics:read |
analytics_forms | Estatísticas de envios de formulário de contato para uma empresa ou um chatbot (widget de analytics do painel): envios por status (pending/approved/rejected/spam), número de formulários, total, taxa de spam em percentagem e a série de envios-por-dia dos últimos 7 dias. | analytics:read |
analytics_leads | Funil de leads para uma empresa ou um chatbot (widget de analytics do painel): leads por status (new/contacted/qualified/converted/lost), total, taxa de conversão em percentagem e a série de leads-por-dia dos últimos 7 dias. | analytics:read |
analytics_overview | Visão geral de analytics para uma empresa ou um chatbot: chats, mensagens, taxa de satisfação e principais perguntas para um período móvel (day/week/month/year), além do widget de overview do painel (total de chatbots/FAQs publicadas/leads, sessões hoje/esta semana/este mês, leads hoje/esta semana, envios de formulário total/hoje/pending). | analytics:read |
dashboard_activity | O que atualmente precisa de atenção (a visão home do painel): por empresa, os chatbots com novos leads hoje, sugestões de FAQ pendentes, envios de formulários pendentes, live chats em espera/ativos ou uma fase de aprendizado em andamento. | any |
Exemplos de Fluxos
Adicionando uma Instrução Principal
Peça ao seu assistente de IA:
"Adicione uma instrução principal ao meu chatbot 'Support Bot': oferecemos frete grátis em pedidos acima de €50"
O assistente usará chatbot_add_instruction com os parâmetros apropriados.
Revisando Sugestões de Melhoria
"Mostre todas as propostas de melhoria pendentes para o meu chatbot e explique quais mudanças elas sugerem"
O assistente irá:
- Usar
improvement_proposals_pendingpara buscar propostas - Analisar e resumir cada sugestão
- Aprovar ou rejeitar em seu nome com
improvement_proposal_approveouimprovement_proposal_reject
Analisando o Desempenho de Chats
"Me dê um relatório semanal do volume de chats e satisfação de clientes para meu chatbot"
O assistente utilizará analytics_overview e analytics_chat_volume para compilar um relatório abrangente.
Importando um Site
"Escanear https://example.com, importar as páginas de produto e preços para meu 'Support Bot' e me avisar quando o rastreamento terminar"
O assistente chamará crawler_preview_scan, escolherá as páginas relevantes, iniciará a importação com crawler_start e fará polling em crawler_job_get até o job terminar.
Revisando Leads e Envios de Formulário
"Mostre os novos leads desta semana, atribua os qualificados para Anna e aprove os envios de formulário pendentes"
O assistente combina lead_list, lead_assign, form_submissions_list e form_submission_update_status.
Assumir um Live Chat
"Marque-me disponível para live chat e assuma a conversa mais antiga em espera"
O assistente usa live_chat_set_availability, live_chat_queue e live_chat_session_assign; as respostas passam por live_chat_message_send.
Segurança
- As chaves de API são vinculadas à sua empresa e aos escopos de permissão que você seleciona ao criá-las (veja a coluna Scope acima)
- As chaves executam com as permissões do proprietário da empresa; limites de plano e gates de recurso se aplicam exatamente como no painel
- As chaves podem ser revogadas a qualquer momento pelo painel
- O acesso à API está disponível em planos pagos — veja nossa página de Preços
Solução de Problemas
Conexão Falhou
- Verifique se sua chave de API está correta
- Verifique se a chave não foi revogada
- Certifique-se de que seu plano inclui acesso à API
- Reinicie seu cliente MCP
Ferramenta Não Encontrada
Reinicie seu cliente MCP após alterar a configuração para que ele recarregue as ferramentas disponíveis. Os nomes das ferramentas são minúsculos com underscores (por exemplo, faq_list).
Precisa de ajuda? Contact our support team →