Ferramentas e escopos do servidor MCP

Cada ferramenta só funciona se a chave tiver o escopo indicado. Para criar a chave, veja Conectar assistentes de IA.

Como funcionam os escopos

• Escopos de leitura (terminam em _read) consultam dados. Escopos de alteração (terminam em _write) fazem mudanças que podem ser desfeitas e incluem a leitura do módulo.
• O escopo pii_read (Dados pessoais sem máscara) entrega e-mail, telefone e documento completos. Sem ele, esses dados chegam mascarados nas ferramentas marcadas com "dados pessoais".
• As listas são paginadas: limit define a página (até 100) e cursor recebe o next_cursor anterior.
• O recurso precisa estar no plano da academia. O plano necessário aparece no topo deste artigo. As ferramentas de Growth valem só para a chave do Bot externo.

Membros

• members_list: lista membros, com filtro por nome, status e grupo. Lê. Escopo members_read. Dados pessoais.
• member_get: mostra um membro com matrículas e grupos. Lê. Escopo members_read. Dados pessoais.
• member_progress: mostra o progresso de um membro por curso. Lê. Escopo members_read.

Grupos de acesso

• access_groups_list: lista os grupos e a quantidade de pessoas. Lê. Escopo access_groups_read.
• access_group_members_list: lista quem está em um grupo. Lê. Escopo access_groups_read. Dados pessoais.
• access_group_add_member: coloca no grupo quem já é membro da academia. Altera. Escopo access_groups_write.
• access_group_remove_member: tira do grupo e remove só o acesso dado por aquele grupo. Altera. Escopo access_groups_write.

Entrar ou sair de um grupo tem o mesmo efeito do painel: pode iniciar as automações da academia ligadas ao grupo.

Vendas

Vendas, assinaturas e cupons são só leitura.

• sales_overview: resume vendas, reembolsos e assinaturas do período. Lê. Escopo sales_read.
• sales_orders_list: lista pedidos do período. Lê. Escopo sales_read. Dados pessoais.
• sales_order_get: mostra um pedido do checkout próprio. Lê. Escopo sales_read. Dados pessoais.
• sales_refunds_list: lista reembolsos, reembolsos em andamento e chargebacks do período. Lê. Escopo sales_read. Dados pessoais.
• sales_coupons_list: lista cupons e usos. Lê. Escopo sales_read.
• subscriptions_list: lista assinaturas dos compradores. Lê. Escopo subscriptions_read. Dados pessoais.

Carteira

Só leitura: nenhuma ferramenta faz estorno, saque ou transferência.

• academy_pay_balance: mostra o saldo disponível e bloqueado. Lê. Escopo academy_pay_read.
• academy_pay_statement: lista os lançamentos recentes. Lê. Escopo academy_pay_read.
• academy_pay_withdrawals_list: lista os pedidos de saque recentes. Lê. Escopo academy_pay_read.
• finance_dre: mostra a DRE de um mês (caixa ou competência). Lê. Escopo finance_read; exige a permissão de financeiro.
• finance_entries_list: lista contas a pagar e a receber (em aberto, vencidas, pagas). Lê. Escopo finance_read. Dados pessoais.
• finance_cashflow: mostra o fluxo de caixa diário ou mensal, com a previsão. Lê. Escopo finance_read.

Avisos

• notices_list: lista avisos com status e visualizações. Lê. Escopo notices_read.
• notice_get: mostra um aviso completo. Lê. Escopo notices_read.
• notice_create_draft: cria um aviso, sempre como rascunho. Altera. Escopo notices_write.
• notice_set_status: pausa, arquiva ou volta o aviso a rascunho. Para publicar o aviso aos alunos, ative no painel. Altera. Escopo notices_write.

Suporte

• lesson_comments_list: lista comentários das aulas para moderar. Lê. Escopo comments_read.
• lesson_comments_moderate: aprova, rejeita ou oculta comentários; nunca apaga nem responde. Altera. Escopo comments_write.
• support_tickets_list: lista chamados dos alunos. Lê. Escopo support_read. Dados pessoais.
• support_ticket_get: mostra um chamado com a conversa, sem as notas internas da equipe. Lê. Escopo support_read. Dados pessoais.
• support_ticket_update: muda só status e prioridade; nunca responde ao aluno. Altera. Escopo support_write.

Relatórios

• reports_overview: traz os números principais do período. Lê. Escopo reports_read.
• reports_tab: traz uma aba dos relatórios, só com números agregados. Lê. Escopo reports_read.

Comunidade

• community_structure: mostra comunidades, categorias e tópicos. Lê. Escopo community_read.
• community_posts_list: lista publicações, sem mensagens diretas. Lê. Escopo community_read. Dados pessoais.
• community_post_moderate: fixa ou desafixa uma publicação. Ocultar continua no painel, porque retira os pontos do autor. Altera. Escopo community_write.

Gamificação

• gamification_catalog: mostra regras de pontos, níveis e selos. Lê. Escopo gamification_read.
• gamification_ranking: mostra o ranking de pontos do período. Lê. Escopo gamification_read.
• gamification_levels_simulate, gamification_store_get: simulam os níveis (só contagens) e leem a loja de pontos. Lê. Escopo gamification_read.
• gamification_level_save, gamification_rule_save, gamification_badge_save, gamification_store_item_save: criam níveis, regras, selos e itens da loja em rascunho. gamification_publish liga tudo, com confirmação do servidor. Altera. Escopo gamification_write.

Eventos

• events_list: lista eventos da agenda. Lê. Escopo events_read.
• community_events_list: lista eventos da comunidade com confirmações, só contagens. Lê. Escopo events_read.

Tarefas

• member_tasks_list: lista tarefas exclusivas de membros. Lê. Escopo tasks_read.
• member_task_create: cria uma tarefa exclusiva do membro, sem notificá-lo. Altera. Escopo tasks_write.
• member_task_set_status: ativa, arquiva ou cancela uma tarefa do membro. Altera. Escopo tasks_write.
• community_tasks_list: lista tarefas da comunidade, sem comprovações. Lê. Escopo tasks_read.

Growth

Requer o add-on Growth. Conversas nunca trazem notas internas.

• growth_contacts_search: busca contatos. Lê. Escopo growth_contacts_read. Dados pessoais.
• growth_contact_get: mostra um contato com etiquetas e oportunidades. Lê. Escopo growth_contacts_read. Dados pessoais.
• growth_contact_tag: adiciona ou remove uma etiqueta de um contato. Etiquetas que iniciam automações só mudam no painel. Altera. Escopo growth_contacts_write.
• growth_pipelines_list: lista funis de vendas e etapas. Lê. Escopo growth_pipeline_read.
• growth_board_get: mostra um funil com suas oportunidades. Lê. Escopo growth_pipeline_read.
• growth_opportunity_move: move uma oportunidade aberta entre etapas abertas; ganho, perda e reabertura continuam no painel. A mudança de etapa pode rodar as automações do funil. Altera. Escopo growth_pipeline_write.
• growth_conversations_list: lista conversas da caixa de entrada. Lê. Escopo growth_conversations_read. Dados pessoais.
• growth_conversation_messages: mostra as mensagens de uma conversa. Lê. Escopo growth_conversations_read. Dados pessoais.

Growth: configurar com a IA

Guia em Configurar o CRM com sua IA. Tudo no escopo growth:config (chaves novas nascem só leitura; só dono/admin habilitam). Automações nascem como rascunho; lotes acima de 50 pedem confirmação com a contagem exata.

• growth_pipeline_create: cria um funil com as etapas do modelo. Altera.
• growth_pipeline_update: renomeia um funil. Altera.
• growth_stage_create: cria uma etapa aberta no funil. Altera.
• growth_stage_update: atualiza nome/cor da etapa. Altera.
• growth_stage_reorder: reordena as etapas abertas. Altera.
• growth_stage_archive: exclui uma etapa vazia e sem uso em automações. Altera.
• growth_opportunity_create: cria um card (contato, valor, etapa, dono). Altera.
• growth_opportunity_update: atualiza título, valor e dono do card. Altera.
• growth_tag_create: cria uma etiqueta. Altera.
• growth_tag_update: renomeia uma etiqueta. Altera.
• growth_tag_archive: exclui etiqueta sem vínculos (recusa com dependentes). Altera.
• growth_custom_field_create: cria um campo personalizado. Altera.
• growth_custom_field_update: atualiza rótulo/ajuda do campo. Altera.
• growth_contact_create: cria um contato com dedupe por telefone/e-mail. Altera. Dados pessoais.
• growth_contact_update: atualiza nome/status do contato. Altera. Dados pessoais.
• growth_segment_create: cria um segmento dinâmico. Altera.
• growth_segment_update: atualiza nome/definição do segmento. Altera.
• growth_flow_get: lê o JSON da automação. Lê.
• growth_flow_create: cria uma automação como rascunho (incompleto aceito; publicar exige pronto). Altera.
• growth_flow_update: salva rascunho (incompleto aceito). Altera.
• growth_flow_validate: valida sem salvar. Lê.
• growth_flow_publish: publica e ativa (canal/modelo bloqueiam; automação com remoção de curso ou arquivamento de contato confirmados só é publicada no painel). Altera.
• growth_flow_pause: pausa uma automação ativa. Altera.
• growth_flows_list: lista as automações (nome e status). Lê.
• growth_flow_triggers_catalog: catálogo de gatilhos e das propriedades filtráveis. Lê.
• growth_flow_actions_catalog: catálogo de ações, passos (inclusive menu, grupo, dados e IA), variáveis e regras do desenho. Lê.
• growth_flow_graph_apply: monta ou edita o rascunho da automação em lote (adicionar, ligar, alterar, remover, gatilhos e meta), tudo ou nada, e devolve passos soltos e problemas. Nunca publica. Altera.
• funnel_maps_list, funnel_map_get, funnel_map_validate, funnel_map_entities_list: listam, leem e validam mapas de funil e os itens que cada passo pode usar. Lê.
• funnel_map_create_from_template: cria um mapa de funil em rascunho (vendas, captura ou em branco). Altera.
• funnel_map_apply: monta o mapa em lote (passos, ligações, itens), sempre em rascunho. Altera.
• growth_forms_list, growth_form_get, growth_scheduling_list: leem formulários, quiz, agendas e páginas de agendamento. Lê.
• growth_form_create, growth_form_step_upsert, growth_form_update, growth_event_type_save, growth_calendar_availability_set: montam formulário, quiz, página de agendamento (pausada) e horários, em rascunho. Altera.
• growth_form_publish, growth_event_type_set_status: colocam no ar, com confirmação do servidor. Altera.
• growth_quick_reply_create, growth_quick_reply_update: criam e atualizam uma resposta rápida. Altera.
• growth_quick_reply_archive: arquiva uma resposta rápida (some do Chat; growth_quick_reply_update restaura). Altera.
• growth_message_templates_list: lista modelos do WhatsApp com status. Lê.
• growth_contacts_bulk_tag: aplica etiqueta em lote (idempotente). Altera.

Certificados e checkout

• certificate_templates_list, certificates_list, checkout_extras_get, checkout_page_get, product_pixels_get: leem modelos, certificados emitidos (nome em iniciais), extras, páginas e pixels. Lê.
• certificate_template_save monta o modelo desligado; certificate_template_set_enabled, certificate_issue_manual, certificate_revoke, checkout_order_bump_set, checkout_upsell_set e product_pixel_set pedem confirmação do servidor. Altera. Escopos catalog_write, members_write e store_write.
• checkout_page_blocks_apply grava só o rascunho da página de checkout e pede a versão lida em checkout_page_get (expected_version); se a página mudou, nada é gravado. O checkout no ar só muda quando alguém clica em Publicar no editor. Altera. Escopo store_write.

IA

• ai_tutors_list: lista os tutores de IA. Lê. Escopo ai_read.
• ai_usage_summary: resume créditos e uso de IA do ciclo, sem conteúdo de conversas. Lê. Escopo ai_read.

Configurações

• settings_get: mostra configurações seguras da academia, sem segredos. Lê. Escopo settings_read.
• plan_usage_get: mostra plano, recursos ativos e uso. Lê. Escopo settings_read.
• brand_settings_get, email_templates_list: leem a marca e os e-mails com texto próprio. Lê. brand_settings_set, email_template_set: mudam marca e texto de e-mail na hora, com confirmação do servidor. Altera. Escopos visual_settings_read e visual_settings_write.

Outros módulos

Há mais ferramentas, por módulo:

• Cursos, aulas, áreas e grupos de acesso: catalog_read e catalog_write.
• Páginas livres e links curtos: pages_read e pages_write.
• Academy Player (biblioteca, envio, IA do vídeo): player_read e player_write.
• Produtos, preços, afiliados e cupons: store_read e store_write.
• Alunos e matrículas: members_write. Migração em lote: migration_write.