Ferramentas do conector MCP do OctaGym por área, com o que cada uma faz e a permissão que exige.
list_mcp_areas apresenta as áreas disponíveis na autorização atual, com
orientações, quantidades de ferramentas e URLs para criar conexões específicas.
Consulte Conexões por área.
Você não precisa decorar as ferramentas — o cliente
de IA escolhe sozinho. Esta página serve para saber o que é possível e qual permissão cada
capacidade exige.
Você só enxerga o que pode
A listagem abaixo é o catálogo completo. Numa conexão real aparecem só as ferramentas liberadas
pelo escopo da conexão e pelo cargo do usuário — veja
Permissões e segurança.
Permissão — a chave que o cargo precisa ter. — significa que qualquer membro ativo alcança.
Tipo — Escrita exige a conexão com escopo mcp:write, entra no rate limit e é auditada.
Algumas ferramentas de escrita apenas simulam (preview_benefit_batch, as prévias de público de
campanha, ou qualquer uma com dry_run: true), mas seguem no regime de escrita porque exigem uma
chave de gestão.
Ferramentas de escrita do financeiro aceitam dry_run; várias deferem ao painel de aprovações.
As métricas abrem para qualquer permissão de leitura de módulo, mas cada número segue a mesma
regra da Visão Geral do dashboard: base ativa, churn, risco, funil e retenção só aparecem com
reports:read; MRR, receita e inadimplência só com finance:read; check-ins e ocupação só com
access:read. Sem a chave, o valor vem zerado e a série temporal vem vazia.
Ferramenta
O que faz
Permissão
Tipo
get_business_metrics
MRR, churn, ocupação, funil, receita por plano, em-risco.
qualquer permissão de leitura de módulo (reports:read, finance:read, students:read…)
Leitura
get_day_pass_conversion
Coorte: compradores de diária que viraram plano depois.
qualquer permissão de leitura de módulo (reports:read, finance:read, students:read…)
Leitura
get_metrics_trends
Séries temporais: MRR (finance:read), churn (reports:read) e check-ins (access:read).
qualquer permissão de leitura de módulo (reports:read, finance:read, students:read…)
Possíveis duplicidades entre negócios e clientes, com evidência por CPF, e-mail e telefone.
students:read
Leitura
list_pipelines
Pipelines e fases válidas.
students:read
Leitura
create_deal
Cria deal no pipeline.
students:manage
Escrita
update_deal
Atualiza campos do deal.
students:manage
Escrita
update_deal_phase
Move o deal entre fases.
students:manage
Escrita
Para auditar o Pipeline, peça list_deal_duplicates no grupo Deals. A primeira chamada devolve grupos paginados de coincidências exatas; status é ativo por padrão e todos inclui todos os status. Use pipeline_id para restringir o funil e match_by para CPF, e-mail ou telefone. Para consultar todos os registros de um grupo, repita a chamada com o match_by e o identity_value retornados, percorrendo page até pagination.has_more=false. Negócios e clientes trazem seus IDs, contatos e ficha de aluno quando houver.
O relatório não altera cadastros. Telefones brasileiros com/sem código 55 e com/sem o nono dígito móvel são comparados pela identidade normalizada. CPF inválido e contato vazio não geram grupo. conflicting_cpfs avisa quando um contato é compartilhado por CPFs válidos diferentes. Vínculo correto isolado e negócios já unificados não são sinalizados. Várias oportunidades da mesma pessoa podem ser legítimas: revise o contexto antes de decidir e não some grupos como se fossem pessoas distintas.
Permanência, frequência e heatmap dia×hora do período.
access:read
Leitura
get_event
Evento + categorias (planos).
plans:read
Leitura
get_occupancy
current_count / max_capacity por unidade.
access:read
Leitura
get_workout_program
Ficha completa com dias e exercícios.
workouts:read
Leitura
list_classes
Aulas agendadas com horário, sala e ocupação.
classes:read
Leitura
list_event_registrations
Inscritos, categoria, status e check-in.
plans:read
Leitura
list_events
Eventos com datas, status e capacidade.
plans:read
Leitura
list_exercises
Biblioteca de exercícios (própria + global); sem include_hidden, deixa de fora os do OctaGym que a empresa ocultou.
workouts:read
Leitura
list_recent_checkins
Acessos por método (facial, wellhub, totalpass, manual).
access:read
Leitura
list_equipment
Parque de equipamentos: marca, série, local, status, fornecedor e garantia. Preço, depreciação, valor contábil, classe do ativo e baixa só com equipment:financial.
equipment:read
Leitura
list_staff
Funcionários (sem dados sensíveis de RH).
team_members:read
Leitura
list_trainers
Instrutores com especializações e avaliação.
classes:read
Leitura
list_workout_programs
Programas de treino com status e aluno.
workouts:read
Leitura
create_event
Cria evento como rascunho (admin).
plans:manage
Escrita
create_event_category
Adiciona horário/modalidade com preço e vagas (admin).
plans:manage
Escrita
register_event
Inscreve aluno numa categoria (waitlist auto).
plans:manage
Escrita
update_event
Edita datas, local e status do evento (admin).
plans:manage
Escrita
update_event_category
Edita nome, preço, vagas e status da categoria (admin).
plans:manage
Escrita
update_staff
Vínculo operacional: cargo, unidade, regime, desligamento (sem RH sensível).
team_members:manage
Escrita
set_global_exercise_visibility
Oculta (ou mostra de novo) exercício do catálogo OctaGym só nesta empresa. Fichas existentes não mudam.
workouts:manage
Escrita
create_exercise
Exercício novo na biblioteca própria.
workouts:manage
Escrita
update_exercise
Edita exercício próprio (o do OctaGym não se edita).
workouts:manage
Escrita
deactivate_exercises
Desativa exercícios próprios que não estão em nenhuma ficha.
workouts:manage
Escrita
create_equipment
Cadastra aparelho no parque da unidade (campos operacionais).
equipment:manage
Escrita
update_equipment
Edita local, status, modelo do parque e dados do aparelho.
Lista os templates de WhatsApp (Cloud API) da empresa em QUALQUER status — PENDING, APPROVED, REJECTED (com motivo), PAUSED, DISABLED — e o ciclo local (draft/submitting/submitted/error).
marketing:read
Leitura
get_email_campaign_report
Status, contadores e taxas de uma campanha; com include_recipients, o status por destinatário (e-mail), como a tela de envios.
marketing:read
Leitura
list_draft_campaigns
Rascunhos pendentes de envio.
marketing:read
Leitura
list_marketing_lists
Listas estáticas com contagem de contatos.
marketing:read
Leitura
list_whatsapp_resources
Inboxes Cloud API e templates aprovados.
marketing:read
Leitura
preview_email_audience
Conta destinatários de um segmento e mostra amostra (nome e e-mail). Não grava nada.
marketing:manage
Escrita
preview_notification_audience
Conta alunos de uma audiência e mostra amostra. Não grava nada.
marketing:manage
Escrita
preview_whatsapp_audience
Dimensiona o disparo com a mesma resolução do envio, com amostra (nome e telefone). Não grava nada.
marketing:manage
Escrita
confirm_campaign_send
Dispara um rascunho na hora (envio real); campanha agendada mantém o horário.
marketing:manage
Escrita
create_email_campaign
Rascunho de e-mail (não envia).
marketing:manage
Escrita
attach_email_campaign_image
Insere uma foto no corpo do rascunho por upload direto (sign → PUT → commit).
marketing:manage
Escrita
create_marketing_list
Materializa um segmento como lista estática (snapshot).
marketing:manage
Escrita
create_notification_campaign
Rascunho push/in-app; com scheduled_at, agenda o envio.
marketing:manage
Escrita
create_promotion
Cria cupom/promoção para a oferta.
promotions:manage
Escrita
create_whatsapp_broadcast
Rascunho de broadcast (template); com scheduled_at, agenda o envio.
marketing:manage
Escrita
create_whatsapp_template
Cria um template de WhatsApp Cloud API e opcionalmente o submete à aprovação da Meta (submit=true).
Conversa a conversa, em nome do usuário conectado — não é campanha. O envio pede confirmação no
cliente de IA antes de executar e alcança uma pessoa por vez; para muita gente, o caminho continua
sendo o disparo em rascunho (create_whatsapp_broadcast).
Ferramenta
O que faz
Permissão
Tipo
list_whatsapp_conversations
Conversas das caixas ativas, com contato, aluno vinculado, responsável, não lidas e a janela de 24h da Cloud API; busca por nome, telefone ou trecho.
students:read
Leitura
get_whatsapp_conversation
Histórico cronológico da conversa (quem falou, mídia, modelo, nota interna, falha) e o que pode ser enviado agora.
students:read
Leitura
send_whatsapp_message
Envia uma mensagem numa conversa ou para um telefone: texto livre dentro da janela de 24h, ou modelo aprovado fora dela, assinada com o crachá do usuário. Exige conexão OAuth.
Este grupo permite acompanhar e responder aos chamados da própria Empresa sem liberar a caixa
de WhatsApp. As ações de escrita exigem conexão OAuth em nome de um usuário.
Ferramenta
O que faz
Permissão
Tipo
list_support_tickets
Lista chamados com filtros e paginação.
— (chamados próprios)
Leitura
get_support_ticket
Lê histórico público e anexos de um chamado.
— (chamados próprios)
Leitura
get_support_attachment_url
Gera URL temporária de um anexo público.
— (chamados próprios)
Leitura
create_support_ticket
Abre chamado em nome do usuário conectado.
settings:manage
Escrita
reply_support_ticket
Responde publicamente a um chamado próprio.
settings:manage
Escrita
set_support_ticket_status
Resolve ou reabre chamado próprio dentro da janela permitida.
Modelos 3D publicáveis no portal — o Blender que converte o arquivo roda no worker do OctaGym, e
estas ferramentas o comandam: enviar, inspecionar o que pesa, derivar uma versão reduzida e
reprocessar. As de escrita exigem sessão de usuário (chave de API é recusada), porque cada
versão registra quem a criou.
Ferramenta
O que faz
Permissão
Tipo
get_scene_project
Versões (status, fase, erro, triângulos) e link público.
portal:read
Leitura
get_scene_version
Relatório traduzido, estatísticas, preview assinado (1 h) e próximo passo.
portal:read
Leitura
list_scene_objects
Objetos da versão por triângulos, coleção e visibilidade — o que reduzir quando o modelo passa do teto.
portal:read
Leitura
list_scene_projects
Projetos 3D com a última versão e o status.
portal:read
Leitura
commit_scene_upload
Confere o objeto enviado e enfileira a conversão.
portal:manage
Escrita
create_scene_project
Projeto vazio (rascunho, link não listado).
portal:manage
Escrita
derive_scene_version
Versão nova a partir de outra, com decimate / delete_objects aplicados pelo Blender do worker.
portal:manage
Escrita
import_scene_source
O worker baixa a fonte de um endereço https público e converte.
portal:manage
Escrita
retry_scene_version
Volta uma versão com falha para a fila.
portal:manage
Escrita
sign_scene_upload
URL assinada para PUT do arquivo (até 2 GB); depois commit_scene_upload.
O desenho da academia em metros: paredes, portas e janelas, ambientes com área e os
aparelhos e móveis do catálogo com a medida real. O Claude transcreve o projeto do arquiteto
(PDF, imagem, DXF) ou desenha a partir de uma conversa, e vê a imagem do que desenhou para
conferir. Toda edição é um lote atômico de operações sobre a revisão lida — se alguém mexeu no
painel no meio, a edição é recusada em vez de sobrescrever. Comece por get_floor_plan_guide.
Ferramenta
O que faz
Permissão
Tipo
get_floor_plan_guide
Convenções, operações de desenho, catálogo com medida real e o passo a passo de PDF/DXF.
floor_plans:read
Leitura
get_floor_plan
Paredes, vãos, ambientes, itens, áreas e problemas do desenho (colisão, porta travada).
floor_plans:read
Leitura
list_floor_plans
Plantas por Unidade/andar, com a revisão atual.
floor_plans:read
Leitura
render_floor_plan
Imagem da planta em escala, com códigos ou nomes, zoom e destaque.
floor_plans:read
Leitura
create_floor_plan
Planta vazia com a área de desenho em metros.
floor_plans:manage
Escrita
edit_floor_plan
Lote de operações (desenhar, mover, girar, duplicar, alinhar, apagar), com simulação e imagem.
A foto da ficha do produto e de cada variação, com as regras da tela de produtos: JPG, PNG ou
WEBP de até 5 MB. Para padronizar uma Unidade pela outra, leia a foto com get_product na
Empresa de origem e envie a mesma image_url como source_url na Empresa de destino — a foto
é pública, então nada lê o cadastro da outra Empresa.
Ferramenta
O que faz
Permissão
Tipo
set_product_image
Envia ou troca a foto de um produto ou variação (por id ou SKU), por URL ou base64.
sales:manage
Escrita
apply_product_image_to_family
Copia a foto do pai para as variações, ou da variação para o pai; preserva quem já tem foto.
Algumas operações existem no OctaGym mas não foram expostas ao conector, porque são destrutivas
ou disparam efeitos fora do sistema:
exclusão de produto, evento, categoria de evento e template de WhatsApp;
exclusão ou estorno integral de título financeiro (o caminho é cancel_financial_title para
títulos em aberto e reverse_settlement para desfazer uma baixa);
criação de funcionário (create_staff), que dispara o onboarding da conta;
qualquer exclusão física de registro — no OctaGym, cancelar e desativar são status.
Essas ações continuam disponíveis no dashboard, com o histórico de quem fez.