MCP

Catálogo de tools

Com o token de uma conta PicChat, o MCP registra 25 tools de consulta — todas somente leitura. Você não chama as tools direto: pede em linguagem natural e o Claude escolhe qual usar. Cada tool só aparece se o usuário do token tiver a permissão correspondente (veja Token e permissões).

Conta

picchat_get_accountGET /v1/me

Mostra a conta dona do token (nome, tipo, plano, créditos, canais e usuários) e, em conta padrão, o usuário por trás do token, o grupo de permissão e quais consultas ele pode fazer. É a primeira tool a chamar.

Permissão: Nenhuma: qualquer token da conta.

“Qual é o meu plano na PicChat e quantos créditos ainda tenho?”

Canais

picchat_list_channelsGET /v1/channels

Lista os canais da conta (WhatsApp Oficial, Instagram, SMS, RCS, e-mail...) com id, nome, tipo, número, status e configurações de atendimento. O id serve de channel_id nas outras tools.

Permissão: Canais › ver ou Inbox › ver (só com Inbox › ver, aparecem apenas os canais do usuário).

Parâmetros (2)

typestring
Filtra pelo tipo do canal.
statusstring
Filtra pelo status do canal.

“Quais canais de WhatsApp eu tenho conectados e qual está ativo?”

Templates

picchat_list_templatesGET /v1/templates

Lista os modelos de mensagem da conta (WhatsApp, SMS, e-mail, RCS) com nome, idioma, categoria, status de aprovação na Meta e as variáveis do corpo.

Permissão: Templates › ver.

Parâmetros (5)

statusstring
Status de aprovação na Meta: "APPROVED", "PENDING", "REJECTED" ou "PAUSED". Omita para todos.
channel_idstring
Só modelos deste canal.
searchstring
Busca por nome ou texto do corpo.
pageinteger
Página (começa em 1).
limitinteger
Itens por página (1 a 100).

“Me mostra os templates aprovados do canal de vendas.”

Tíquetes

picchat_list_ticketsGET /v1/tickets

Lista os tíquetes (conversas de atendimento) com status, atendente, tags, última mensagem e não lidas. Filtra por status, canal, atendente, contato, tag, período ou texto.

Permissão: Inbox › ver. Usuário com grupo de permissão vê só os canais vinculados a ele.

Parâmetros (15)

statusstring
Nome do status (ex.: "Abertos", "Resolvidos"); veja picchat_list_ticket_status.
status_idstring
ID do status, alternativa ao nome.
channel_idstring
Só tíquetes deste canal.
user_idstring
Só tíquetes deste atendente; "none" para os sem responsável.
contact_idstring
Só tíquetes deste contato.
tag_idstring
Só tíquetes com esta tag.
openboolean
true = só em aberto; false = só encerrados.
unreadboolean
true = só com mensagens não lidas.
searchstring
Busca por nome, e-mail ou telefone do contato, número público do tíquete ou última mensagem.
sortstring
Campo de ordenação: "created_at", "updated_at" (padrão) ou "last_message_date".
fromstring
Início do período de criação, em ISO 8601 (ex.: 2026-09-01 ou 2026-09-01T00:00:00Z).
tostring
Fim do período de criação, em ISO 8601 (só a data inclui o dia inteiro).
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quantos tíquetes estão abertos sem atendente responsável agora?”

picchat_get_ticketGET /v1/tickets/{id}

Detalhe de um tíquete pelo id ou número público, com contato, atendente, status, tags e contagem de mensagens e notas.

Permissão: Inbox › ver. Usuário com grupo de permissão vê só os canais vinculados a ele.

Parâmetros (1)

idstringobrigatório
ID do tíquete (uuid) ou número público (ex.: "1532").

“Abre o tíquete 1532 e me diz quem está atendendo.”

Mensagens

picchat_list_messagesGET /v1/messages

Lista mensagens da conta: com ticket_id lê uma conversa inteira em ordem; com contact_id, o histórico do contato. Cada item traz direção, tipo, corpo, arquivo e status de entrega e leitura.

Permissão: Inbox › ver. Usuário com grupo de permissão vê só os canais vinculados a ele.

Parâmetros (14)

ticket_idstring
Mensagens de um tíquete (ordem cronológica por padrão).
contact_idstring
Mensagens trocadas com um contato.
channel_idstring
Só mensagens deste canal.
automation_idstring
Mensagens disparadas por uma automação.
template_idstring
Mensagens enviadas com este modelo.
typestring
Tipo: text, image, audio, video, document, template, interactive...
statusstring
Status de envio (ex.: completed, error, pending).
from_meboolean
true = enviadas pela conta; false = recebidas do contato.
searchstring
Busca no corpo da mensagem.
fromstring
Início do período de criação, em ISO 8601 (ex.: 2026-09-01 ou 2026-09-01T00:00:00Z).
tostring
Fim do período de criação, em ISO 8601 (só a data inclui o dia inteiro).
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Lê a conversa do tíquete 1532 e resume o que o cliente pediu.”

picchat_get_messageGET /v1/messages/{id}

Detalhe de uma mensagem pelo id: corpo, arquivo, status e horários de envio, entrega e leitura.

Permissão: Inbox › ver. Usuário com grupo de permissão vê só os canais vinculados a ele.

Parâmetros (1)

idstringobrigatório
ID da mensagem.

“Essa mensagem que mandei para a Maria Souza foi lida? O id é 0193f0a2-4b1c-7d3e-8f4a-5b6c7d8e9f20.”

Contatos

picchat_list_contactsGET /v1/contacts

Lista os contatos com busca por nome, e-mail ou telefone e filtros por lista, opt-out, número inválido, período e valor de propriedade. Com include_properties, cada contato vem com as propriedades em { internal_name: valor }.

Permissão: Contatos › ver.

Parâmetros (16)

searchstring
Nome, sobrenome, e-mail, usuário ou telefone (parcial).
mobilephonestring
Telefone exato (DDI 55 é adicionado quando faltar).
emailstring
E-mail exato.
list_idstring
Só contatos que estão nesta lista.
opt_outboolean
true = só quem pediu para não receber mais mensagens.
invalid_numberboolean
true = só contatos com número marcado como inválido.
is_groupboolean
true = só grupos de WhatsApp.
statusstring
Status do contato.
propertiesobject<string, string>
Filtro por propriedade: { "internal_name": "valor" }. Em seleção, aceita o nome ou o internal_name da opção. Vira property.<internal_name> na query.
include_propertiesboolean
Inclui as propriedades de cada contato na resposta.
sortstring
Campo de ordenação: "created_at", "updated_at" ou "first_name".
fromstring
Início do período de criação, em ISO 8601 (ex.: 2026-09-01 ou 2026-09-01T00:00:00Z).
tostring
Fim do período de criação, em ISO 8601 (só a data inclui o dia inteiro).
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Lista os contatos com etapa do funil "Lead" que entraram este mês.”

picchat_get_contactGET /v1/contacts/{id}

Detalhe de um contato com todas as propriedades, as listas em que está e a quantidade de tíquetes.

Permissão: Contatos › ver.

Parâmetros (1)

idstringobrigatório
ID do contato.

“Me mostra o cadastro completo da Maria Souza e em quais listas ela está.”

Propriedades

picchat_list_propertiesGET /v1/properties

Lista as propriedades (campos) de contato com nome, internal_name, tipo, grupo e opções de seleção. As padrão da plataforma vêm com default=true.

Permissão: Propriedades › ver ou Contatos › ver.

Parâmetros (6)

searchstring
Busca por nome ou internal_name.
typestring
internalName do tipo (ex.: text, select, date).
group_idstring
Só propriedades deste grupo.
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quais campos personalizados de contato eu tenho e quais são do tipo seleção?”

picchat_get_propertyGET /v1/properties/{id}

Detalhe de uma propriedade pelo id ou internal_name, com tipo, grupo e opções.

Permissão: Propriedades › ver ou Contatos › ver.

Parâmetros (1)

idstringobrigatório
ID ou internal_name da propriedade.

“Quais são as opções da propriedade etapa_do_funil?”

Listas

picchat_list_listsGET /v1/lists

Lista as listas de contatos (estáticas ou dinâmicas por filtro) com a contagem atual de membros.

Permissão: Listas › ver.

Parâmetros (6)

typestring
Tipo da lista (estática ou dinâmica).
statusstring
Status da lista.
searchstring
Busca pelo nome.
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quais são minhas listas de contatos e quantas pessoas tem em cada uma?”

picchat_get_listGET /v1/lists/{id}

Detalhe de uma lista de contatos, com os filtros (se dinâmica) e a contagem de membros.

Permissão: Listas › ver.

Parâmetros (1)

idstringobrigatório
ID da lista.

“Qual é o filtro da lista "Clientes recorrentes"?”

Campanhas

picchat_list_campaignsGET /v1/campaigns

Lista as campanhas com as automações vinculadas e os totais de enviadas, entregues, lidas, respondidas e erros.

Permissão: Campanhas › ver.

Parâmetros (5)

statusstring
Status da campanha.
searchstring
Busca pelo nome.
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Como foram minhas campanhas deste mês em entregas e respostas?”

picchat_get_campaignGET /v1/campaigns/{id}

Detalhe de uma campanha com suas automações e totais.

Permissão: Campanhas › ver.

Parâmetros (1)

idstringobrigatório
ID da campanha.

“Detalha a campanha de Black Friday: quantas mensagens foram lidas?”

Automações

picchat_list_automationsGET /v1/automations

Lista as automações de disparo com modelo, canal, campanha, tipo, status, agendamento e contadores (total, pendentes, erro, entregues, lidas, respondidas, tempos médios).

Permissão: Automações › ver.

Parâmetros (12)

campaign_idstring
Só automações desta campanha.
channel_idstring
Só automações deste canal.
template_idstring
Só automações que usam este modelo.
statusstring
Status da automação.
typestring
Tipo da automação (whatsapp, sms, email...).
activeboolean
true = só ativas; false = só desativadas.
searchstring
Busca pelo nome.
fromstring
Início do período de criação, em ISO 8601 (ex.: 2026-09-01 ou 2026-09-01T00:00:00Z).
tostring
Fim do período de criação, em ISO 8601 (só a data inclui o dia inteiro).
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quais automações de WhatsApp estão ativas e quantos erros cada uma teve?”

picchat_get_automationGET /v1/automations/{id}

Detalhe de uma automação com os contadores de envio.

Permissão: Automações › ver.

Parâmetros (1)

idstringobrigatório
ID da automação.

“Como está a automação de boas-vindas? Quantas mensagens estão pendentes?”

Usuários

picchat_list_usersGET /v1/users

Lista os usuários (atendentes) da conta com cargo, status, se está online e os canais em que atendem.

Permissão: Usuários › ver.

Parâmetros (6)

searchstring
Nome, sobrenome ou e-mail.
statusstring
Status do usuário.
onlineboolean
true = só quem está online agora.
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quem da equipe está online agora?”

Status de tíquete

picchat_list_ticket_statusGET /v1/ticket-status

Lista os status possíveis de um tíquete (Abertos, Pendentes, Resolvidos, Fechados...) com id, nome e cor.

Permissão: Inbox › ver.

“Quais status de atendimento existem na minha conta?”

Notas

picchat_list_notesGET /v1/notes

Lista as notas internas dos atendentes (não visíveis ao contato) de um tíquete ou contato.

Permissão: Inbox › ver. Usuário com grupo de permissão vê só os canais vinculados a ele.

Parâmetros (9)

ticket_idstring
Notas deste tíquete.
contact_idstring
Notas deste contato.
channel_idstring
Notas de tíquetes deste canal.
searchstring
Busca no texto da nota.
fromstring
Início do período de criação, em ISO 8601 (ex.: 2026-09-01 ou 2026-09-01T00:00:00Z).
tostring
Fim do período de criação, em ISO 8601 (só a data inclui o dia inteiro).
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“O que a equipe anotou sobre a Maria Souza nos atendimentos?”

Assistentes de IA

picchat_list_assistantsGET /v1/assistants

Lista os assistentes de IA com tipo, modelo, status, instruções, parâmetros, canais, ferramentas habilitadas (sem credenciais) e quantidade de itens de conhecimento.

Permissão: Assistentes › ver.

Parâmetros (7)

channel_idstring
Só assistentes que atendem neste canal.
typestring
Tipo do assistente.
statusstring
Status do assistente.
searchstring
Busca pelo nome.
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quais assistentes de IA estão atendendo no canal de vendas?”

picchat_get_assistantGET /v1/assistants/{id}

Configuração completa de um assistente de IA: instruções, persona, parâmetros, canais, ferramentas e pipeline vinculada.

Permissão: Assistentes › ver.

Parâmetros (1)

idstringobrigatório
ID do assistente.

“Me mostra as instruções do assistente de pré-venda e sugere melhorias.”

Bases de conhecimento

picchat_list_knowledge_basesGET /v1/knowledge-bases

Lista as bases de conhecimento usadas pelos assistentes, com título, origem, canais vinculados e quantidade de itens.

Permissão: Base de conhecimento › ver.

Parâmetros (5)

channel_idstring
Só bases vinculadas a este canal.
searchstring
Busca pelo título.
pageinteger
Página (começa em 1).
limitinteger
Itens por página: padrão 20, máximo 100.
orderstring
Ordem cronológica: "asc" ou "desc".

“Quais bases de conhecimento o assistente do suporte usa?”

picchat_get_knowledge_baseGET /v1/knowledge-bases/{id}

Detalhe de uma base de conhecimento com canais vinculados e contagem de itens.

Permissão: Base de conhecimento › ver.

Parâmetros (1)

idstringobrigatório
ID da base de conhecimento.

“Quantos itens tem a base "Perguntas frequentes" e em quais canais ela vale?”

Catálogo de tools

Conta

Canais

Templates

Tíquetes

Mensagens

Contatos

Propriedades

Tags

Listas

Campanhas

Automações

Usuários

Status de tíquete

Notas

Assistentes de IA

Bases de conhecimento