Conector de IA (MCP)
Catálogo de ferramentas
As 151 ferramentas do conector MCP do OctaGym por área, com o que cada uma faz e a permissão que exige.
Catálogo de ferramentas
São 151 ferramentas: 80 de leitura e 71 de escrita. Você não precisa decorar nenhuma — 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.
Como ler as tabelas
- Permissão — a chave que o cargo precisa ter.
—significa que qualquer membro ativo alcança. - Tipo —
Escritaexige a conexão com escopomcp:write, entra no rate limit e é auditada. Algumas ferramentas de escrita apenas simulam (preview_benefit_batch, ou qualquer uma comdry_run: true), mas seguem no regime de escrita. - Ferramentas de escrita do financeiro aceitam
dry_run; várias deferem ao painel de aprovações.
Ferramentas por área
Contexto e empresa
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_team_context | Marca, planos, aulas, instrutores e cidade. | — (qualquer membro) | Leitura |
list_authorized_teams | Lista as empresas autorizadas nesta conexão (id + nome), para escolher o team_id. | — (qualquer membro) | Leitura |
list_stores | Unidades (filiais) da empresa. | — (qualquer membro) | Leitura |
Cérebro do gestor (risco e prioridades)
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_command_briefing | O que mudou no risco nas últimas horas. | students:read | Leitura |
get_member_billing_risk | Risco de inadimplência por aluno. | finance:read | Leitura |
get_member_risk | Score de churn + breakdown de fatores. | students:read | Leitura |
list_at_risk_members | Churn risk score por aluno + fatores. | students:read | Leitura |
list_past_due_members | Mensalidades vencidas, por dias em atraso. | finance:read | Leitura |
Métricas do negócio
| 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_metrics_trends | Séries temporais: MRR, churn, check-ins. | qualquer permissão de leitura de módulo (reports:read, finance:read, students:read…) | Leitura |
Clientes (CRM)
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_client | Cadastro completo de um cliente. | students:read | Leitura |
list_clients | Busca e paginação de clientes (CRM). | students:read | Leitura |
create_client | Cria cliente (valida CPF/CNPJ). | students:manage | Escrita |
update_client | Atualiza campos de um cliente. | students:manage | Escrita |
Alunos e mensalidades
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_member | Perfil completo do aluno. | students:read | Leitura |
list_members | Alunos + cliente vinculado. | students:read | Leitura |
list_memberships | Mensalidades/matrículas com plano e status. | finance:read | Leitura |
cancel_membership | Cancela a matrícula e o aluno. | finance:manage | Escrita |
create_member | Cria cliente + member_profile. | students:manage | Escrita |
enroll_member | Matrícula: cria a mensalidade num plano (não cobra). | students:enroll ou finance:manage | Escrita |
freeze_membership | Congela até uma data (respeita limite do plano). | finance:manage | Escrita |
unfreeze_membership | Reativa a mensalidade congelada. | finance:manage | Escrita |
update_member | Atualiza o perfil do aluno. | students:manage | Escrita |
Retenção
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
list_expiring_memberships | Alunos com mensalidade a vencer (renovação). | finance:read | Leitura |
list_inactive_members | Sem check-in há N dias (win-back). | students:read | Leitura |
Deals (funil comercial)
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_deal | Deal completo. | students:read | Leitura |
list_deals | Negociações com filtros. | 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 |
Financeiro
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_acquirer_reconciliation | Faturado OctaGym × Stripe/Pagar.me, com divergência. | finance:read | Leitura |
get_cash_flow | Realizado por liquidação + projetado por vencimento. | finance:read | Leitura |
get_dre | Demonstração de resultado do período com margens. | finance:read | Leitura |
get_financial_aging | Títulos em aberto por faixa de atraso/vencimento. | finance:read | Leitura |
get_financial_summary | Receitas, despesas, saldo, em aberto e vencido do período. | finance:read | Leitura |
get_financial_title | Título completo + liquidações + anexos + trilha de auditoria. | finance:read | Leitura |
list_acquirer_payouts | Repasses ao banco, saldo do provedor e saúde do sync. | finance:read | Leitura |
list_acquirer_receivables | O que entra líquido e quando, por data de liquidação. | finance:read | Leitura |
list_bank_transactions | Movimentos bancários e o que já foi conciliado. | finance:read | Leitura |
list_commissions | Comissões apuradas com regra, beneficiário e origem. | commissions:read | Leitura |
list_cost_centers | Centros de custo da empresa. | finance:read | Leitura |
list_dre_entries | Lançamentos que compõem uma linha da DRE. | finance:read | Leitura |
list_financial_accounts | Contas, saldos e sincronização com o provedor. | finance:read | Leitura |
list_financial_categories | Contas contábeis, hierarquia e mapeamento de DRE. | finance:read | Leitura |
list_financial_projects | Dimensão de rateio por projeto. | finance:read | Leitura |
list_financial_settlements | Pagamentos, estornos, reduções e ajustes por título. | finance:read | Leitura |
list_financial_titles | Contas a pagar e a receber com valores, datas, categoria e status. | finance:read | Leitura |
list_fiscal_invoices | NF-e/NFS-e emitidas com vínculo à venda ou matrícula. | finance:read | Leitura |
list_payment_disputes | Contestações com prazo, evidência e vínculo ao título. | finance:read | Leitura |
list_suppliers | Cadastro de fornecedores com dados de pagamento mascarados. | finance:read ou purchasing:read ou equipment:maintenance | Leitura |
bulk_update_financial_titles | Mesmo patch em até 200 títulos, fail-fast; >20 vai à aprovação. | finance:manage | Escrita |
cancel_financial_title | Status → cancelado com motivo. Nunca apaga. | finance:manage | Escrita |
create_cost_center | Nome único, código e descrição. | finance:manage | Escrita |
create_financial_account | Corrente, caixa, cartão ou investimento. | finance:manage | Escrita |
create_financial_category | Plano de contas com hierarquia e mapeamento DRE. | finance:manage | Escrita |
create_financial_title | Conta a pagar/receber (com parcelamento e política de Compras). | finance:manage | Escrita |
create_supplier | Cadastro com CPF/CNPJ validado e dados de pagamento. | finance:manage | Escrita |
deactivate_supplier | Soft — histórico permanece. | finance:manage | Escrita |
generate_benefit_batch | Idempotente por colaborador/competência (via aprovação). | finance:manage | Escrita |
link_staff_to_counterparty | Corrige colaborador cadastrado como fornecedor. | finance:manage | Escrita |
merge_suppliers | Reaponta referências do duplicado (via aprovação). | finance:manage | Escrita |
preview_benefit_batch | Dias × tarifa por colaborador, sem gravar (exige também team_members:hr). | finance:manage | Escrita |
recalculate_benefit_batch | Corrige dias/tarifa dos títulos em aberto. | finance:manage | Escrita |
request_payment_refund | Cria solicitação de estorno no painel de aprovações (não estorna direto). | finance:manage | Escrita |
reverse_settlement | Estorno de uma baixa específica, com motivo. | finance:manage | Escrita |
schedule_payment | Data programada e urgência da fila do dia. | finance:manage | Escrita |
send_payments_to_paggo | Pré-valida o lote e cria a solicitação de envio (via aprovação). | finance:manage | Escrita |
settle_financial_title | Baixa total/parcial; acima do limite vai à aprovação. | finance:manage | Escrita |
update_cost_center | Nome, código, descrição, status. | finance:manage | Escrita |
update_financial_account | Dados e status; conta integrada é read-only. | finance:manage | Escrita |
update_financial_category | Respeita contas de sistema e hierarquia. | finance:manage | Escrita |
update_financial_title | Edita título; pago/conciliado só classificação (resto via estorno). | finance:manage | Escrita |
update_supplier | Completa contato e dados bancários/PIX. | finance:manage | Escrita |
Catálogo, produtos e vendas
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_product | Detalhe com estoque por unidade, lotes e grade. | sales:read | Leitura |
list_class_types | Tipos de aula ativos. | classes:read | Leitura |
list_plans | Planos ativos. | plans:read | Leitura |
list_product_brands | Marcas registradas do catálogo. | sales:read | Leitura |
list_product_categories | Categorias/subcategorias do catálogo. | sales:read | Leitura |
list_products | Produtos da loja. | sales:read | Leitura |
list_promotions | Cupons/promoções vigentes. | promotions:read | Leitura |
list_sales | Vendas recentes. | sales:read | Leitura |
adjust_product_stock | Movimenta estoque com lote, validade e custo. | products:manage | Escrita |
create_product | Produto avulso no padrão do wizard. | products:manage | Escrita |
create_product_category | Categoria/subcategoria do catálogo. | products:manage | Escrita |
create_product_family | Família pai + SKUs de sabor/tamanho/cor. | products:manage | Escrita |
update_product | Nome, preço, custo, categoria, status... | products:manage | Escrita |
Operação (aulas, treinos, eventos, acesso, equipe)
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
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). | workouts:read | Leitura |
list_recent_checkins | Acessos recentes (entry/exit, granted/denied). | access: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 |
Marketing e campanhas
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_whatsapp_template_status | 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. | 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. | marketing:read | Leitura |
preview_notification_audience | Conta alunos de uma audiência. | marketing:read | Leitura |
preview_whatsapp_audience | Dimensiona o disparo com a mesma resolução do envio. | marketing:read | Leitura |
confirm_campaign_send | Dispara um rascunho (envio real). | marketing:manage | Escrita |
create_email_campaign | Rascunho de e-mail (não envia). | marketing:manage | Escrita |
create_marketing_list | Materializa um segmento como lista estática (snapshot). | marketing:manage | Escrita |
create_notification_campaign | Rascunho push/in-app/email. | marketing:manage | Escrita |
create_promotion | Cria cupom/promoção para a oferta. | promotions:manage | Escrita |
create_whatsapp_broadcast | Rascunho de broadcast (template). | marketing:manage | Escrita |
create_whatsapp_template | Cria um template de WhatsApp Cloud API e opcionalmente o submete à aprovação da Meta (submit=true). | marketing:manage | Escrita |
discard_campaign | Remove um rascunho não enviado. | marketing:manage | Escrita |
Meta Ads
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
meta_get_ad | Retorna detalhes completos de um ad pelo ID. | marketing:read | Leitura |
meta_get_adset | Retorna detalhes completos de um adset pelo ID. | marketing:read | Leitura |
meta_get_campaign | Retorna detalhes completos de uma campanha pelo ID. | marketing:read | Leitura |
meta_get_insights | Métricas (impressions, clicks, spend, CPM, CPC, CTR, ROAS, conversions). Aceita IDs de account, campaign, adset ou ad. | marketing:read | Leitura |
meta_list_ad_accounts | Contas de anúncio autorizadas pela empresa na integração Meta Ads. | marketing:read | Leitura |
meta_list_ads | Lista os ads (anúncios individuais) de um adset. | marketing:read | Leitura |
meta_list_adsets | Lista os adsets de uma campanha. | marketing:read | Leitura |
meta_list_campaigns | Lista campanhas de uma ad account, com filtro por status. | marketing:read | Leitura |
meta_list_pending_actions | Lista writes do Meta Ads aguardando aprovação. | marketing:read | Leitura |
meta_confirm_action | Confirma e executa uma ação pendente. Use após revisar em meta_list_pending_actions. | marketing:manage | Escrita |
meta_create_ad | Cria um ad anexando um creative_id existente a um adset. | marketing:manage | Escrita |
meta_create_ad_creative | Cria um criativo a partir de um object_story_spec. Use após meta_upload_image para criativos de imagem. | marketing:manage | Escrita |
meta_create_adset | Cria um adset com targeting, budget e optimization_goal explícitos. | marketing:manage | Escrita |
meta_create_campaign | Cria campanha na ad account (exige special_ad_categories por compliance da Meta). | marketing:manage | Escrita |
meta_create_custom_audience | Cria uma custom audience vazia (popule com meta_update_custom_audience_users). | marketing:manage | Escrita |
meta_pause_campaign | Atalho de status para estancar verba (com approval gate). | marketing:manage | Escrita |
meta_reject_action | Rejeita uma ação pendente (não executa contra a Meta API). | marketing:manage | Escrita |
meta_resume_campaign | Atalho de status para religar a campanha (com approval gate). | marketing:manage | Escrita |
meta_update_ad | Atualiza campos arbitrários de um ad. | marketing:manage | Escrita |
meta_update_adset | Atualiza campos arbitrários de um adset. | marketing:manage | Escrita |
meta_update_campaign | Atualiza campos arbitrários (name, status, daily_budget, etc.). | marketing:manage | Escrita |
meta_update_custom_audience_users | Os valores em data DEVEM ser hashes SHA-256 lowercase (Meta não aceita PII em claro). Não pode ser diferida pelo approval gate. | marketing:manage | Escrita |
meta_upload_image | Faz upload de uma imagem (via URL pública) para criativos. Retorna o image_hash. | marketing:manage | Escrita |
Portal white-label
| Ferramenta | O que faz | Permissão | Tipo |
|---|---|---|---|
get_portal_components | Blocos disponíveis + schemas de props. | portal:read | Leitura |
get_portal_page | HTML atual + preview. | portal:read | Leitura |
list_dynamic_slots | Placeholders data-block do bloco CustomHTML. | — (qualquer membro) | Leitura |
list_portal_pages | Páginas do portal white-label. | portal:read | Leitura |
create_portal_page | Cria página (rascunho). | portal:manage | Escrita |
publish_portal_page | Publica uma versão no portal público. | portal:manage | Escrita |
rollback_portal_page | Volta a publicação para versão anterior. | portal:manage | Escrita |
update_portal_page | Nova versão (rascunho). | portal:manage | Escrita |
Fora do catálogo (de propósito)
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_titlepara títulos em aberto ereverse_settlementpara 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.