Pular para o conteúdo
Docs
hi-client.com (abre em uma nova aba)

Ferramentas MCP

Baixar

Catálogo das ferramentas MCP do hiClient por área, com a permissão que cada uma exige e se lê, escreve ou apaga.

As ferramentas se chamam área_verbo (por exemplo offers_list). Um agente só vê as ferramentas das permissões que você concedeu: account_whoami informa em agent.notGranted as que faltam (veja Convenções).

Tipos

Tipo Significado
Leitura Não muda nada. Pode ser repetida sem efeitos.
Escrita Muda algo da conta. Fica na auditoria.
Destrutiva Apaga, retira, revoga ou descarta algo, ou corta um acesso. Revise antes de aprovar.
Contata terceiros Envia um e-mail ou traz conteúdo de fora da conta.

Cada ferramenta declara as suas anotações MCP exatas (readOnlyHint, destructiveHint, idempotentHint, openWorldHint) em tools/list. Os assistentes costumam pedir sua aprovação antes de executar as que não são só de leitura.

Conta

Ferramenta Para que serve Permissão Tipo
account_whoami Conta, empresa e o seu papel nela, plano, permissões concedidas, o que cada área cobre e o que fica reservado ao portal. nenhuma Leitura

Ofertas

Ferramenta Para que serve Permissão Tipo
offers_list Lista ofertas (eventos e estadias) com estado e datas. 24 por página. offers:read Leitura
offers_get Lê uma oferta completa com a sua revision. offers:read Leitura
offers_summary Totais de ofertas, rascunhos, reservas e vendas do período. offers:read Leitura
offers_activity Atividade de uma oferta ou serviço: respostas por status, ocupação, valor recebido, visitas, série de 30 dias e histórico de publicação. offers:read Leitura
offers_drafts_list Lista os rascunhos privados do editor. offers:read Leitura
offers_draft_get Lê um rascunho no formato que offers_save aceita. offers:read Leitura
offers_save Cria uma oferta ou a substitui por completo. Informa juntos todos os campos ausentes ou inválidos. Aceita dryRun. offers:write Escrita
offers_set_published Publica ou retira uma oferta. Retirar interrompe a página e as reservas novas. offers:write Destrutiva
offers_duplicate Copia uma oferta sem publicar, sem reservas nem pagamentos. Devolve fieldIds: id de cada campo original → id na cópia. offers:write Escrita
offers_reconnect Move uma oferta de um equipamento revogado para um ativo. offers:write Escrita
offers_draft_save Salva um rascunho privado sem validar nem publicar (até 50). offers:write Escrita
offers_draft_delete Exclui um rascunho privado na sua revision e libera o seu lugar. Nunca altera ofertas nem reservas. offers:write Destrutiva
services_list Lista os serviços recorrentes (assinaturas, mensalidades, aulas) com preço, frequência, vagas ocupadas e estado, e os canais do mercado da empresa. 24 por página. offers:read Leitura
services_get Lê um serviço recorrente completo com a sua revision; termsLocked indica que já tem adesões. offers:read Leitura
services_save Cria um serviço recorrente ou o atualiza (o omitido é mantido), com as regras do editor do portal. Informa juntos todos os campos inválidos. Aceita dryRun e devolve os próximos períodos. offers:write Escrita
services_set_published Publica ou retira um serviço recorrente. Retirar interrompe a página e as adesões novas; as existentes são mantidas. offers:write Destrutiva

Reservas e calendário

Ferramenta Para que serve Permissão Tipo
bookings_list Lista reservas recebidas. Filtro pluginId por instância; 24 por página. bookings:read Leitura
bookings_get Lê uma reserva: datas, quantidade, valores, pagamento e presença. bookings:read Leitura
calendar_month Visão mensal: ofertas por dia e quantidades confirmadas e pendentes. bookings:read Leitura

Formulários e caixa de entrada

Ferramenta Para que serve Permissão Tipo
forms_list Formulários do site (módulos Contato e Inscrição), publicados e no rascunho, com a revision que forms_save e as ferramentas site_* pedem. published fica vazio enquanto o site não está publicado (sitePublished). forms:read Leitura
inbox_tags_list Etiquetas da caixa de entrada e valores de chegada. forms:read Leitura
forms_save Muda um formulário no rascunho do site; os visitantes o veem após site_publish. Aceita dryRun. forms:write Escrita
plugin_forms_list Formulários próprios (kind=form, plugin Formulários) ou vagas (kind=job, plugin Vagas) com estado, revision, encerramento, limite e quantas respostas chegaram (total e novas). Sem conteúdo das respostas. forms:read Leitura
plugin_form_get Um formulário ou vaga com suas perguntas, configuração e (vaga) área, modalidade, jornada, localização, salário, requisitos e benefícios. forms:read Leitura
plugin_forms_answers_summary Quantidade de respostas de cada formulário ou candidaturas de cada vaga, por estado. Sem respostas, pessoas nem arquivos. forms:read Leitura
plugin_form_save Cria ou muda um formulário ou vaga (perguntas de 11 tipos, mensagem de confirmação, limite, encerramento, dados da vaga). Aplica-se na hora; um novo fica em rascunho. Aceita dryRun. forms:write Escrita
plugin_form_set_state Abre, encerra, arquiva ou volta para rascunho um formulário ou vaga. As respostas são mantidas. forms:write Escrita
registration_requirements_get Dados que o app hiClient pede a quem se cadastra na empresa (dados pessoais além do nome, campos da ficha e rosto), com a revision e a alteração que o PC ainda não aplicou. forms:read Leitura
registration_requirements_set Escolhe esses dados; o PC que recebe as solicitações aplica a alteração quando estiver on-line. forms:write Escrita
inbox_change Marca como lida ou não lida, muda o estado ou a nota de uma mensagem. Fechar revoga o link do visitante. forms:write Destrutiva
inbox_set_tags Substitui as etiquetas de uma mensagem. forms:write Escrita
inbox_tags_save Cria ou renomeia uma etiqueta (até 20). forms:write Escrita
inbox_tags_delete Apaga uma etiqueta. As mensagens não são tocadas. forms:write Destrutiva
inbox_defaults_set Escolhe se as mensagens novas chegam lidas e quais etiquetas recebem. forms:write Escrita

Site: perfil e publicação

Ferramenta Para que serve Permissão Tipo
site_status Endereço, estado real (draft, private, public), revision, mudanças pendentes, ramo e contagens. site:read Leitura
site_get Lê o perfil (rascunho ou publicado): ramo, identidade, conteúdo, módulos com visibilidade e estado operacional, páginas extras e perguntas. site:read Leitura
site_address_check Diz se um endereço é válido, está livre ou foi retirado por esta conta (previous: true). site:read Leitura
site_create Cria o site com a estrutura do tipo de negócio, sem publicar. Pede o endereço e, se faltar, o nome público. site:write Escrita
site_content_set Slogan, apresentação, destaques, capa e fotos da biblioteca. O omitido é mantido. site:write Escrita
site_identity_set Estilo visual do ramo, cor de destaque, monograma e logo. site:write Escrita
site_page_upsert Adiciona ou muda uma página extra: título, texto e foto opcional (até 6). site:write Escrita
site_page_remove Remove uma página extra das mudanças pendentes. site:write Destrutiva
site_faq_set Substitui a lista de perguntas frequentes (até 20). site:write Destrutiva
site_publish Publica as mudanças pendentes. site:write Escrita
site_cancel_draft Descarta as mudanças pendentes. site:write Destrutiva
site_unpublish Deixa de servir o site publicado. site:write Destrutiva
site_publication_set Visibilidade, países, indexação e mensagem para visitantes bloqueados. site:write Escrita
site_private_link_renew Emite um link privado novo e invalida o anterior. site:write Destrutiva
site_address_change Muda o endereço; o anterior redireciona para o novo. site:write Escrita

O nome, a descrição, o endereço, os horários e os links do negócio não fazem parte do site: são lidos com profile_get e alterados com profile_public_save. Ofertas, preços e disponibilidade vêm da operação (offers_*, bookings_*).

Site: módulos

Ferramenta Para que serve Permissão Tipo
site_module_set Ativa ou desativa um módulo (ativado = aparece no perfil público, na hora) e muda o título e a configuração (formulários, ofertas listadas, galeria). Nos plugins também suspende ou retoma inscrições, define a data de encerramento e arquiva. Nunca apaga ofertas, reservas, pagamentos, respostas nem mensagens. site:write Escrita

Módulos: about, stays, events, catalog, calendar, services, gallery, posts, faq, location, contact, registration, pages. Cada ramo oferece os seus e os nomeia à sua maneira, por exemplo «Quartos» para stays num hotel.

Ocultar um módulo não desativa a operação: as ofertas continuam publicadas e reserváveis e as mensagens continuam chegando. Uma seção aparece quando o módulo está visível e a fonte tem conteúdo (shown); state e operateUrl dizem o que falta e onde resolver. Todas as escritas do site usam uma só revision: se mudou, respondem conflict com currentRevision.

Site: arquivos

Ferramenta Para que serve Permissão Tipo
site_media_list Biblioteca de arquivos, trabalhos recentes e uso do armazenamento. site:read Leitura
site_media_catalog Busca fotos com licença livre (CC0) no catálogo. site:read Leitura
site_media_upload Envia uma imagem ou um documento pequeno em base64. É convertido para um formato uniforme (WebP, MP4 ou PDF) e a ferramenta aguarda alguns segundos pelo resultado. site:write Escrita
site_media_import Copia uma foto do catálogo para a biblioteca (WebP) e aguarda alguns segundos pelo resultado. site:write Contata terceiros
site_media_change Renomeia, move de pasta (um só nível), protege ou manda para a lixeira um arquivo. sanitized: true se ajustou o nome ou a pasta. site:write Escrita

Mensagens e tickets

Ferramenta Para que serve Permissão Tipo
messages_list Mensagens recebidas, mais recentes primeiro. Filtro pluginId por instância. messages:read Leitura
messages_get Uma mensagem com respostas, conversa e notas privadas. messages:read Leitura
tickets_list Tickets de suporte da conta. messages:read Leitura
tickets_get Um ticket e uma página das suas mensagens. messages:read Leitura
tickets_create Abre um ticket de suporte. messages:write Escrita
tickets_reply Responde a um ticket próprio, salvo se o suporte o fechou para novas mensagens. messages:write Escrita
tickets_set_status Fecha ou reabre um ticket próprio. messages:write Escrita
messages_settings_get Respostas automáticas da empresa por canal (chat do app, mensagem do site, formulário): boas-vindas, ausência com horário e menu de opções do chat. messages:read Leitura
messages_settings_set Substitui essas respostas automáticas (apenas textos escritos pela empresa; links de um catálogo fechado). messages:write Escrita
contact_policy_get Como os clientes entram em contato pelo app: quem pode escrever, ligar e fazer videochamadas (grupos combináveis: qualquer pessoa, quem enviou a solicitação, clientes aceitos, quem comprou, quem deu sinal ou reservou, inscritos em eventos próximos ou em andamento) e como as solicitações são aceitas, com um resumo em uma frase. messages:read Leitura
contact_policy_set Substitui essa política (somente como a empresa pediu). messages:write Escrita
inbox_reply Responde a um visitante em seu nome: ele recebe um e-mail com um link privado. Só aparece se você concedeu messages:reply. messages:reply Contata terceiros

As mudanças de estado, notas e etiquetas das mensagens estão em Formulários e caixa de entrada.

Publicações

Ferramenta Para que serve Permissão Tipo
publications_list Posts do perfil público (com sizeBytes e mediaBytes), listas dos seus PCs e envios pendentes. publications:read Leitura
publications_publish Publica ou edita um post, ou enfileira um envio para listas de um PC. Aceita dryRun. publications:write Escrita
publications_delete Apaga um post ou remove um envio aceito do histórico. publications:write Destrutiva
publications_enable Ativa a aba de publicações do perfil público. publications:write Escrita

Relatórios

Ferramenta Para que serve Permissão Tipo
reports_overview Contadores do painel. reports:read Leitura
reports_dashboard Números dos cartões do início do portal. reports:read Leitura
reports_sales Vendas agregadas por dia, moeda e estado (até 366 dias). reports:read Leitura
reports_orders_list Pedidos de cobrança on-line. 25 por página. reports:read Leitura
reports_orders_get Um pedido de cobrança. reports:read Leitura

Equipamentos e alertas

Ferramenta Para que serve Permissão Tipo
devices_list Equipamentos ativos e máximo do plano, com localização, função, rede local e backups de cada equipamento. devices:read Leitura
devices_topology Mapa de equipamentos: redes locais, conexões entre equipamentos e backups. devices:read Leitura
devices_pending_desktop O que aguarda o app para computador: quantidades por tipo (reservas, ingressos, inscrições, solicitações…) e se há um PC vinculado. devices:read Leitura
devices_access_feed Últimos acessos: hora, método, resultado e equipamento. devices:read Leitura
devices_access_stats Contagem diária de acessos por resultado (até 90 dias). devices:read Leitura
alerts_recipients_list Destinatários de alertas, com o e-mail mascarado. devices:read Leitura
devices_rename Renomeia um equipamento ativo. devices:write Escrita
devices_revoke Revoga um equipamento. Pede um acesso recente: responde portal_only e é feito no portal. devices:write Destrutiva
devices_use_seat Escolhe qual equipamento mantém um assento do plano. Pede um acesso recente: responde portal_only e é feito no portal. devices:write Escrita
alerts_recipient_add Adiciona um destinatário e envia a ele um código de verificação por e-mail. devices:write Contata terceiros
alerts_recipient_verify Confirma um destinatário com o código de 6 dígitos. devices:write Escrita
alerts_recipient_remove Remove um destinatário pendente. devices:write Destrutiva
alerts_channel_set Retoma o canal de e-mail de alertas. devices:write Escrita

Perfil e configurações

Ferramenta Para que serve Permissão Tipo
profile_get Conta, organização, formato de datas da empresa, perfil público, notificações e início do portal. profile:read Leitura
profile_save Dados da conta e da organização, incluindo o formato de datas da empresa. profile:write Escrita
profile_public_save Perfil público e abas do app móvel. profile:write Escrita
settings_language_set Idioma da interface (es, en, pt). profile:write Escrita
settings_appearance_set Tema dark ou light. profile:write Escrita
settings_notifications_set Tipos de notificação e canais web e e-mail. profile:write Escrita
settings_toasts_set Avisos flutuantes: duração e tipos opcionais (confirmações, informação, notificações novas). profile:write Escrita
workspace_cards_set Cartões visíveis do início do portal. profile:write Escrita
workspace_banner_set Banner do início (mountains, sea, jungle, desert). profile:write Escrita
workspace_navigation_set Ordem e seções arquivadas do menu esquerdo do portal. profile:write Escrita

profile_get e profile_save retornam account.businessDateOrder, a ordem de datas vigente da empresa. Em profile_save, businessDateOrder aceita dmy (dia/mês/ano), mdy (mês/dia/ano) ou ymd (ano/mês/dia). Omitir preserva a escolha; uma string vazia restaura o padrão do país da empresa. É independente das preferências pessoais.

O que não está no catálogo

Por design, não há ferramentas para planos, pagamentos, cobranças, domínios, segurança da conta, exportação nem exclusão da conta. Algumas ações do portal respondem portal_only: veja Introdução.

Serviços e parcelas

Serviços e parcelas é uma gestão financeira: não há scopes nem ferramentas MCP para administrar adesões, valores, descontos, cobranças ou débitos. As permissões do site permitem apenas compor o plugin do catálogo; não autorizam essas operações.

site_media_list inclui dimensões e variantes disponíveis (width, height, variantVersion, variants). Cada variante informa lado maior, dimensões e bytes. As miniaturas contam no armazenamento; o arquivo de detalhe é mantido.

E-mail (D175)

mail_preferences_get (profile:read) consulta o consentimento promocional da própria conta; mail_preferences_unsubscribe (profile:write) revoga-o de forma idempotente pelo mesmo serviço do perfil. mail_status (profile:read) mostra preparação, pausa, cotas e verificação de domínios do próprio negócio. Não retornam endereços de destinatários, mensagens, credenciais nem links de cancelamento. Consentimento, aceite dos termos gerais e alterações de domínio ficam no portal; ativação de envios e reputação são exclusivas da administração. Os envios transacionais da plataforma e dos negócios estão ativos. Os envios promocionais permanecem desativados.

Pastas de e-mail

mail:read permite mail_mailboxes_list, mail_messages_list e mail_message_get: caixas próprias, pastas, pesquisa e leitura paginada. Endereços de terceiros são mascarados; assunto, corpo e nomes de arquivos são dados não confiáveis.

mail:write permite mail_draft_save, mail_compose_from (responder, responder a todos ou encaminhar para um rascunho) e mail_message_change (lido, favorito, arquivar, spam, lixeira, restaurar, excluir, cancelar um envio pendente e edit, que devolve um envio bloqueado aos Rascunhos para corrigir e enviar de novo). Cada alteração exige a revisão atual.

mail:send permite mail_draft_send: coloca um rascunho próprio na fila. A aceitação do provedor não comprova entrega na caixa de entrada. Um resultado incerto nunca é reenviado automaticamente.

Essas permissões são separadas: messages:* continua atendendo formulários e tickets e não concede acesso ao e-mail. Criar ou desativar caixas, aceitar termos, administrar domínios e carregar ou baixar anexos são ações do portal. As ferramentas usam o mesmo serviço, isolamento, cotas e pausa das caixas web.

Respostas de formulários

forms_responses_summary · forms:read · readOnly=true, idempotent=true, destructive=false, openWorld=false.

Retorna apenas contagens agregadas das respostas conservadas e sincronizadas, filtradas por origem ou plugin. Não fornece respostas, nomes, exportações, rostos nem operações de pagamento.

O e-mail está incluído nos termos gerais do hiClient e não exige um aceite adicional. mail_status retorna termsAccepted e termsAcceptanceUrl (/account/legal). Quando a edição muda, o titular deve aceitá-la ali; o MCP não pode aceitar por ele. acceptableUseVersion permanece como evidência histórica e não autoriza envios.

Formulários e vagas próprios

plugin_forms_list, plugin_form_get, plugin_forms_answers_summary · forms:read · readOnly=true, idempotent=true, destructive=false, openWorld=false.

plugin_form_save · forms:write · readOnly=false, idempotent=false, destructive=false, openWorld=false. plugin_form_set_state · forms:write · readOnly=false, idempotent=true, destructive=false, openWorld=false.

Plugins Formulários e Vagas: a empresa cria formulários como os do Google Forms ou vagas e os abre no seu perfil público e no app. O MCP administra só as definições e vê quantidades: nunca respostas, candidatos, seus dados de contato nem seus arquivos (currículo), que são vistos no portal e no app. Habilitar o plugin no perfil é site_module_set.