OctoSolveAjuda

Ferramentas

Consulte as vinte e cinco ferramentas do MCP da OctoSolve, seus parâmetros, resultados, riscos e recusas.

Ferramentas

O servidor oferece vinte e cinco ferramentas em sete grupos. Risco Baixo indica leitura. Risco Médio altera dados internos. Risco Alto pode ocupar a agenda de uma pessoa ou avisar o cliente final.

Listas devolvem data, has_more e next_cursor. O limite padrão no MCP é 20 itens, e o máximo é 100. Use next_cursor como cursor na chamada seguinte sem alterar os filtros.

O CPF não sai pelo MCP, inclusive depois de criar ou atualizar um contato. Se a sua integração precisa desse dado, consulte o contato diretamente pela API REST com uma chave autorizada.

Contatos

buscar_contatos

PropriedadeValor
GrupoContatos
RiscoBaixo
ExigeNenhum campo obrigatório. Aceita telefone, q, status, tag, limit e cursor
Limitesq de 2 a 80 caracteres, tag com até 40, limit de 1 a 100, padrão 20
Valores de statusnovo, ativo, inativo ou bloqueado
DevolveLista paginada de contatos, sem CPF

Pode recusar busca curta, limite fora da faixa, status inválido ou cursor reaproveitado com filtros diferentes.

ver_contato

PropriedadeValor
GrupoContatos
RiscoBaixo
Exigecontact_id
DevolveUm contato com dados cadastrais, identidades de canal, tags, situação e data de atualização, sem CPF

Um identificador inexistente ou pertencente a outra conta é tratado como contato não encontrado.

criar_contato

PropriedadeValor
GrupoContatos
RiscoMédio
Exigetelefone
Aceitanome, email, cidade, data_nascimento, observacoes, tags e status
LimitesTelefone de 10 a 20 caracteres na entrada, nome e cidade com até 120, observações com até 2.000, no máximo 20 tags
DevolveO contato criado, sem CPF

O telefone precisa resultar em 10 a 15 dígitos com DDI e DDD. Telefone já cadastrado é conflito. E-mail, data ou situação inválidos são recusados. Uma repetição idêntica na mesma faixa de dez minutos devolve o resultado original em vez de criar duplicata.

atualizar_contato

PropriedadeValor
GrupoContatos
RiscoMédio
Exigecontact_id
Aceitanome, email, cidade, data_nascimento, observacoes, tags e status
LimitesNome e cidade com até 120 caracteres, observações com até 2.000, no máximo 20 tags
DevolveO contato atualizado, sem CPF

Somente os campos enviados são alterados. O valor anterior é sobrescrito. A ferramenta recusa identificador inexistente, e-mail, data ou situação inválidos.

listar_servicos

PropriedadeValor
GrupoCatálogo
RiscoBaixo
ExigeNenhum campo obrigatório
Aceitaativo, q, limit e cursor
Limitesq de 2 a 80 caracteres, limit de 1 a 100, padrão 20
Padrãoativo: true
DevolveLista paginada com nome, descrição, duração, preços, categoria e regras do serviço

Pode recusar busca curta, limite fora da faixa ou cursor reaproveitado com filtros diferentes.

ver_servico

PropriedadeValor
GrupoCatálogo
RiscoBaixo
Exigeservice_id
DevolveUm serviço, inclusive quando inativo

Um identificador inexistente ou pertencente a outra conta é tratado como serviço não encontrado.

Equipe

listar_profissionais

PropriedadeValor
GrupoEquipe
RiscoBaixo
ExigeNenhum campo obrigatório
Aceitaativo, servico_id, limit e cursor
Limitesservico_id em UUID, limit de 1 a 100, padrão 20
Padrãoativo: true
DevolveLista paginada com perfil, estado da agenda e serviços atendidos, sem e-mail do profissional

Pode recusar UUID inválido, limite fora da faixa ou cursor reaproveitado com filtros diferentes.

ver_profissional

PropriedadeValor
GrupoEquipe
RiscoBaixo
Exigeprofessional_id
DevolvePerfil, estado da agenda e serviços atendidos pelo profissional, sem e-mail

Um identificador inexistente ou pertencente a outra conta é tratado como profissional não encontrado.

Agenda

ver_horarios_livres

PropriedadeValor
GrupoAgenda
RiscoBaixo
Exigeservico_id em UUID e data no formato AAAA-MM-DD
Aceitadias e profissional_id em UUID
Limitesdias de 1 a 7, padrão 1, data no máximo 365 dias à frente, até 40 combinações de dia e profissional
DevolveDuração do serviço e slots por dia e profissional. inicio e fim vêm em UTC com Z

A ferramenta recusa serviço ou profissional inexistente, agenda não conectada, intervalo amplo demais e data distante demais. Uma indisponibilidade temporária da agenda também gera recusa. A consulta não reserva o horário.

listar_agendamentos

PropriedadeValor
GrupoAgenda
RiscoBaixo
ExigeNenhum campo obrigatório
Aceitacontact_id, profissional_id, servico_id, lista status, de, ate, limit e cursor
Limiteslimit de 1 a 100, padrão 20
Período padrãoSem de e ate, começa 30 dias antes do momento atual e segue para o futuro
DevolveLista paginada e cronológica de agendamentos

de e ate aceitam data ou data e hora ISO. Sem fuso, o fuso da conta é assumido (Brasília é o padrão de conta nova). A ferramenta recusa período invertido, situação inválida e cursor usado com filtros diferentes.

ver_agendamento

PropriedadeValor
GrupoAgenda
RiscoBaixo
Exigeappointment_id
DevolveEstado atual e todos os campos públicos do agendamento. Datas vêm em UTC com Z

Consulte esta ferramenta antes de alterar. Um identificador inexistente ou pertencente a outra conta é tratado como agendamento não encontrado.

criar_agendamento

PropriedadeValor
GrupoAgenda
RiscoAlto
Exigecontact_id, servico_id e data_hora em ISO
Aceitaprofissional_id, duracao_minutos, valor, notas e notificar_whatsapp
LimitesDuração de 5 a 600 minutos, notas com até 2.000 caracteres
Padrãonotificar_whatsapp: false
DevolveO agendamento criado

Use em data_hora o inicio devolvido por ver_horarios_livres, sem modificar. A ferramenta recusa horário ocupado, serviço inativo, serviço com pagamento antecipado em conta com cobrança automática ligada, entidade inexistente e profissional que não pode atender. Se houver conflito, consulte os horários outra vez e escolha outro. Uma repetição idêntica na mesma faixa de dez minutos devolve o resultado original.

alterar_agendamento

PropriedadeValor
GrupoAgenda
RiscoAlto
Exigeappointment_id
Aceitaprofissional_id, data_hora, duracao_minutos, status, valor, motivo_cancelamento e notas
LimitesDuração de 5 a 600 minutos, motivo com até 500 caracteres, notas com até 2.000
DevolveO agendamento atualizado

Situações aceitas: agendado, confirmado, realizado, no_show, cancelado, aguardando_pagamento, cancelado_por_nao_pagamento, cancelado_estornado e cancelado_lgpd.

A ferramenta aplica estas recusas:

  • Ocorrência de série não pode ser alterada.
  • motivo_cancelamento só pode acompanhar status: "cancelado".
  • Remarcação só pode terminar em agendado ou confirmado.
  • cancelado, realizado e no_show são estados finais.
  • profissional_id: null e duracao_minutos: null não são aceitos.
  • Horário ocupado é conflito e exige uma nova consulta de disponibilidade.

Cancelar não tem volta. Para atender novamente, crie outro agendamento. Se uma repetição receber transição proibida e o estado atual já for o solicitado, considere que a primeira alteração foi concluída.

Base de conhecimento

A base de conhecimento é o que o agente sabe responder. Ela pertence a um agente, não à conta: quem tem mais de um agente escolhe em qual mexer.

Ferramenta nova chega desligada para quem já conectou antes. Ligue em Integrações, na tela do produto. Isso vale inclusive para as de leitura, e é de propósito: nenhuma integração ganha capacidade nova sem alguém pedir.

Regras que valem nas quatro ferramentas de documento:

  • agent_id é opcional. Sem ele, vale o agente padrão da conta. Se a conta não tiver padrão definido, a chamada é recusada pedindo o identificador.
  • Documento marcado como protegido não pode ser editado por aqui. Abra um ticket no suporte.
  • Não existe apagar. Use atualizar_documento com ativo: false, que tem volta.
  • Fatias internas do documento nunca aparecem, e um identificador de fatia é tratado como não encontrado.

listar_agentes

PropriedadeValor
GrupoBase de conhecimento
RiscoBaixo
ExigeNenhum campo
DevolveLista de agentes com id, nome, nome_interno, padrao e status

Use antes das demais quando a conta tiver mais de um agente.

listar_documentos

PropriedadeValor
GrupoBase de conhecimento
RiscoBaixo
ExigeNenhum campo obrigatório. Aceita agent_id, q, ativo, limit e cursor
Limitesq de 2 a 80 caracteres, limit de 1 a 100, padrão 20
DevolveLista paginada de documentos, sem o conteúdo

O texto completo vem em ver_documento. Cursor reaproveitado com filtros diferentes é recusado.

ver_documento

PropriedadeValor
GrupoBase de conhecimento
RiscoBaixo
Exigedocumento_id. Aceita agent_id
DevolveUm documento com o conteúdo inteiro

Consulte antes de reescrever, para não apagar o que já estava lá.

criar_documento

PropriedadeValor
GrupoBase de conhecimento
RiscoMédio
Exigetitulo e conteudo. Aceita categoria e agent_id
LimitesTítulo de 3 a 200 caracteres, conteúdo de 10 a 10.000
categoriaTexto livre de até 60 caracteres, para organizar a base. Sugestões: faq, servico, protocolo, politica, promocao. Sem categoria, vale faq
DevolveO documento criado

O texto é fatiado e indexado automaticamente, então o agente passa a responder a partir dele em seguida.

Esta ferramenta consome o limite de documentos do plano. Atingido o limite, a chamada é recusada com a mensagem do próprio serviço de limites.

Título já usado no mesmo agente é conflito: use atualizar_documento. Uma repetição idêntica na mesma faixa de dez minutos devolve o resultado original em vez de criar duplicata.

Sob concorrência, o serviço de indexação pode pedir uma nova tentativa em alguns segundos.

atualizar_documento

PropriedadeValor
GrupoBase de conhecimento
RiscoMédio
Exigedocumento_id e pelo menos um campo para mudar
Aceitatitulo, conteudo, categoria, ativo e agent_id
LimitesOs mesmos de criar_documento
DevolveO documento atualizado

Mudar o conteúdo reindexa o documento. ativo: false deixa o documento fora das respostas do agente sem apagar nada.

Relatórios

ver_relatorio

PropriedadeValor
GrupoRelatórios
RiscoBaixo
ExigeNenhum campo obrigatório. Aceita de e ate
LimitesDatas em AAAA-MM-DD, no fuso da conta. Janela de no máximo 92 dias
DevolveNúmeros do período, agrupados

Sem de e ate, vale o mês corrente. As duas datas andam juntas: informar só uma é recusado.

A resposta traz periodo, agenda, perdas, dinheiro, conversas, produtividade, custo_ia, por_canal, por_profissional, por_agente, contatos_novos e nps_medio.

Dois relógios diferentes, e isso muda a conta. O bloco agenda conta pelo momento em que o agendamento foi marcado; o bloco perdas conta pela data do atendimento. São populações diferentes, então subtrair perdas.cancelados_no_periodo de agenda.marcados_no_periodo produz um número sem significado. Para a agenda de um dia ou de uma semana, use listar_agendamentos, que filtra pela data do atendimento.

O relatório não traz dado de cliente final: nome, telefone e comentário de pesquisa de satisfação ficam de fora, mesmo estando no relatório da tela. Profissional e agente aparecem porque são da sua própria equipe.

Conta com um agente só recebe por_agente vazio, e isso não significa ausência de dados. Conta sem plano configurado é recusada com explicação.

Automações

Automação criada pelo MCP nasce desligada. Antes de criar ou editar, consulte as opções da conta para usar nomes de etiquetas, fases, serviços, mídias e agentes que existem de verdade.

A URL secreta do gatilho de webhook não sai pelo MCP. Ela fica na tela de Automações, atrás do login do dono da conta.

listar_automacoes

PropriedadeValor
GrupoAutomações
RiscoBaixo
ExigeNenhum campo obrigatório
DevolveLista de automações com estado, tipos de gatilho, quantidade de ações e histórico resumido de disparos

Não pagina porque cada plano tem um teto pequeno de automações. A resposta nunca inclui a URL secreta nem o segredo de webhook.

ver_automacao

PropriedadeValor
GrupoAutomações
RiscoBaixo
Exigeautomacao_id
DevolveA automação com gatilhos, ações, intervalo entre disparos e os dez últimos disparos

Use antes de editar para preservar a configuração atual. Um identificador inexistente ou pertencente a outra conta é tratado como automação não encontrada. A resposta diz se há webhook, mas não revela a URL secreta nem o segredo.

ver_opcoes_de_automacao

PropriedadeValor
GrupoAutomações
RiscoBaixo
ExigeNenhum campo obrigatório
DevolveTipos aceitos de gatilho e ação, campos necessários, fases, etiquetas, serviços, mídias, agentes e teto do plano

Use antes de criar ou editar. Nome inventado de etiqueta, fase ou serviço pode deixar a automação sem efeito. A resposta também avisa quando um gatilho por intenção depende do plano.

criar_automacao

PropriedadeValor
GrupoAutomações
RiscoMédio
Exigenome, gatilhos e acoes
Aceitaagent_id e cooldown_segundos
LimitesNome de 3 a 120 caracteres, pelo menos um gatilho e uma ação, intervalo de 0 a 86.400 segundos
Padrãocooldown_segundos: 300
DevolveA automação criada, desligada por padrão

Automação criada pelo MCP nasce desligada, sempre. Não existe argumento para criar ligada, e isso é proposital: se existisse, criar já ligada seria um pedido só e a confirmação em dois passos de atualizar_automacao poderia ser contornada. Para ligar, chame atualizar_automacao com ativa: true.

Sem cooldown_segundos, a automação nasce com 300 segundos de intervalo mínimo entre disparos. Envie 0 se ela precisa disparar toda vez. A ferramenta recusa configuração inválida, agente de outra conta, gatilho por intenção fora do plano e teto de automações atingido. Uma repetição idêntica na mesma faixa de dez minutos devolve o resultado original.

atualizar_automacao

PropriedadeValor
GrupoAutomações
RiscoAlto
Exigeautomacao_id e pelo menos um campo para mudar
Aceitanome, gatilhos, acoes, ativa, cooldown_segundos e confirmar
LimitesNome de 3 a 120 caracteres, intervalo de 0 a 86.400 segundos
DevolveA automação atualizada, ou os dados para confirmação

Enviar gatilhos ou acoes substitui a lista inteira, não acrescenta itens. Consulte a automação antes e envie a lista completa. Ligar uma automação desligada exige dois pedidos: o primeiro devolve os gatilhos e as ações para a pessoa conferir, o segundo usa confirmar: true. Desligar vale na hora.

A confirmação em dois passos evita acidente do modelo, não impede um ator malicioso. A proteção real é a ferramenta de escrita começar desligada e só o dono ligá-la na tela de Integrações.

apagar_automacao

PropriedadeValor
GrupoAutomações
RiscoAlto
Exigeautomacao_id
Aceitaconfirmar
DevolveOs dados para confirmação, ou a confirmação de exclusão

Apagar exige dois pedidos. O primeiro nunca apaga e devolve o nome e os disparos da automação. Depois de a pessoa confirmar, envie o segundo pedido com confirmar: true. Um identificador inexistente ou de outra conta é tratado como automação não encontrada. Apagar não tem volta.

Recusas comuns a todas

Uma chamada também pode ser recusada quando:

  • O servidor MCP ou a ferramenta está desligado.
  • A chave está ausente, inválida, revogada, suspensa ou vencida.
  • Uma chave read tenta usar ferramenta de escrita.
  • O plano não inclui MCP ou a conta está suspensa.
  • Um campo obrigatório está ausente ou um argumento não atende ao formato e ao limite.
  • O limite de requisições foi atingido.

A IA recebe a mensagem de negócio em português como erro de ferramenta. Falhas inesperadas devolvem somente uma mensagem genérica, sem detalhes técnicos.