MCP: Funis, etapas e tags

Ferramentas desta área, geradas do código do servidor. As descrições vêm desse código, em português. Para conectar, veja o MCP da XBASE.

`add-board-stage`

Adiciona uma etapa (coluna) a um quadro do workspace. Sem order, entra no fim.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`boardId`	sim	ID do quadro (veja list-boards)
`name`	sim	—
`description`	não	—
`order`	não	Posição (0 = primeira)

`add-contact-address`

Adiciona um endereço ao contato. Rua, cidade e estado são obrigatórios; isMain torna este o endereço principal (o anterior deixa de ser).

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)
`nickname`	não	Apelido (ex.: Casa, Escritório)
`street`	sim	—
`number`	não	—
`complement`	não	—
`district`	não	Bairro
`city`	sim	—
`state`	sim	—
`country`	não	Padrão: Brasil
`zipCode`	não	CEP
`obs`	não	—
`isMain`	não	—

`add-contact-channel`

Adiciona um canal ao contato (WhatsApp, e-mail, Instagram…). source é o número, e-mail ou usuário. Não abre conversa: use get-or-create-thread para isso.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)
`type`	sim	—
`source`	sim	Número (com DDI), e-mail ou usuário do canal
`isPrimary`	não	—
`isVerified`	não	—

`add-thread-member-agent`

Coloca um agente do workspace como membro da thread (ele passa a acompanhar a conversa) sem trocar o responsável. Para trocar o responsável use change-thread-responsible.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`threadId`	sim	ID da thread (veja list-threads)
`agentId`	sim	ID do agente (veja get-agents-by-workspace)

`archive-thread`

Arquiva uma thread do workspace (sai das listas de conversas abertas; nada é apagado). Use archived=false para desarquivar.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`threadId`	sim	ID da thread (veja list-threads)
`archived`	não	true (padrão) arquiva; false desarquiva

Cria um quadro (funil) no workspace. stages cria as etapas na ordem dada (ex.: ["Novo", "Em negociação", "Ganho"]); depois dá para mexer com add-board-stage, update-board-stage e delete-board-stage.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`name`	sim	—
`description`	não	—
`status`	não	—
`stages`	não	Nomes das etapas, na ordem

`delete-board`

DESTRUTIVA E SEM VOLTA: exclui em definitivo o quadro e todas as etapas dele; as threads que estavam no funil ficam sem etapa. Confirme com a pessoa antes de usar.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`boardId`	sim	ID do quadro (veja list-boards)

`delete-board-stage`

DESTRUTIVA E SEM VOLTA: exclui em definitivo uma etapa do quadro; as threads que estavam nela ficam sem etapa. Confirme com a pessoa antes de usar.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`stageId`	sim	ID da etapa (veja get-board ou list-workspace-stages)

`delete-contact`

DESTRUTIVA: exclui um contato do workspace (some das listas e buscas; o histórico das conversas fica). Confirme com a pessoa antes de usar.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)

`duplicate-board`

Cria um quadro novo usando um quadro do workspace como modelo (copia etapas e configurações, sem as threads). Sem description, herda a do modelo.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`boardId`	sim	ID do quadro modelo
`name`	sim	Nome do quadro novo
`description`	não	—

`get-board`

Detalhe de um quadro (funil) do workspace com as etapas em ordem (id, nome, descrição, ordem).

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`boardId`	sim	ID do quadro (veja list-boards)

`get-contact-details`

Ficha de um contato do workspace: dados básicos, canais ativos (com o id usado em update/remove-contact-channel) e endereços (com o id usado em update/remove-contact-address).

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)

`get-thread`

Detalhe de uma thread (negociação/conversa) do workspace: título, status, etapa do funil, contatos, tags, membros e flags (arquivada, fixada, silenciada). As mensagens ficam em get-thread-dialogs.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`threadId`	sim	ID da thread (veja list-threads)

`list-boards`

Lista os quadros (funis) do workspace com as etapas de cada um, em ordem.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`take`	não	Quantidade (padrão 50)
`skip`	não	—

`list-organizations`

Lista as organizações (empresas) do CRM do workspace, das atualizadas mais recentemente para as mais antigas, com paginação. Para buscar por nome/CNPJ/domínio use search-organizations.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`take`	não	Quantidade (padrão 20, máximo 100)
`skip`	não	Quantas pular (paginação)

`remove-contact-address`

DESTRUTIVA: apaga em definitivo um endereço do contato (não há lixeira).

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)
`addressId`	sim	ID do endereço

`remove-contact-channel`

DESTRUTIVA: remove um canal do contato (o número/e-mail deixa de aparecer na ficha). Se era o telefone ou e-mail principal, o contato passa a usar outro canal do mesmo tipo, se houver.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)
`channelId`	sim	ID do canal

`search-contacts`

Lista/busca contatos do workspace com paginação. search procura em nome, e-mail e telefone (sem diferenciar maiúsculas). Devolve id, nome, e-mail, telefone e organização de cada contato.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`search`	não	Termo em nome, e-mail ou telefone
`organizationId`	não	Só contatos desta organização
`take`	não	Quantidade (padrão 20, máximo 100)
`skip`	não	Quantos pular (paginação)

`update-board`

Edita nome, descrição ou status de um quadro do workspace. Para as etapas use add-board-stage, update-board-stage e delete-board-stage.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`boardId`	sim	ID do quadro (veja list-boards)
`name`	não	—
`description`	não	—
`status`	não	—

`update-board-stage`

Renomeia, muda a descrição ou a posição (order) de uma etapa de um quadro do workspace.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`stageId`	sim	ID da etapa (veja get-board ou list-workspace-stages)
`name`	não	—
`description`	não	—
`order`	não	—

`update-contact-address`

Edita um endereço do contato. Só os campos enviados mudam; isMain torna este o principal.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)
`addressId`	sim	ID do endereço
`nickname`	não	—
`street`	não	—
`number`	não	—
`complement`	não	—
`district`	não	—
`city`	não	—
`state`	não	—
`country`	não	—
`zipCode`	não	—
`obs`	não	—
`isMain`	não	—

`update-contact-channel`

Edita um canal do contato: tipo, origem (número/e-mail/usuário), principal, verificado ou ativo. Só os campos enviados mudam.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`contactId`	sim	ID do contato (veja search-contacts)
`channelId`	sim	ID do canal (veja get-contact-details)
`type`	não	—
`source`	não	—
`isPrimary`	não	—
`isVerified`	não	—
`isActive`	não	—

`update-thread`

Edita uma thread do workspace: título, status, etapa do funil (boardStageId de um quadro deste workspace), fixar, silenciar, favoritar, marcar alerta (redFlag) ou arquivar. Só os campos enviados mudam.

Parâmetro	Obrigatório	Descrição
`workspaceId`	não	Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
`threadId`	sim	ID da thread (veja list-threads)
`title`	não	—
`status`	não	—
`boardStageId`	não	ID da etapa (veja get-board ou list-workspace-stages)
`isPinned`	não	—
`isMuted`	não	—
`isFavorite`	não	—
`redFlag`	não	—
`isArchived`	não	—

`list-workspace-stages`

Lista os stages (etapas) de um workspace, com o ID de cada um e o quadro a que pertence. Pode filtrar por quadro (boardId). Use antes de move-thread-to-stage para pegar o boardStageId exato (nomes se repetem entre quadros).

Parâmetro	Obrigatório	Descrição
`workspaceId`	sim	ID do workspace para listar stages
`boardId`	não	ID do quadro para filtrar stages (opcional)

`move-thread-to-stage`

Move a thread para uma etapa (stage) do quadro. PREFIRA boardStageId (ID exato, obtido em list-workspace-stages): nomes se repetem entre quadros. Com stageName, procura primeiro no quadro atual da thread e depois nos outros quadros do mesmo workspace (nunca em outro workspace); se houver mais de uma etapa com o nome, devolve as opções com ID para você escolher. A etapa precisa ser do mesmo workspace da thread.

Parâmetro	Obrigatório	Descrição
`threadId`	sim	ID da thread a ser movida
`boardStageId`	não	ID exato da etapa de destino (preferido). Se vier junto com stageName, vale o boardStageId
`stageName`	não	Nome da etapa de destino (usado quando não houver boardStageId)

`add-tag-to-entity`

Adiciona tag a entidade (thread, agent, contact, rawContact). Cria tag automaticamente se não existir. Use para organização.

Parâmetro	Obrigatório	Descrição
`entityType`	sim	Tipo da entidade (thread, agent, contact, rawContact)
`entityId`	sim	ID da entidade
`tagName`	sim	Nome da tag a ser adicionada
`tagColor`	não	Cor da tag em formato hex (ex: #FF5733)
`createTagIfNotExists`	não	Se deve criar a tag caso não exista (padrão: true)

`create-tag`

Cadastra uma tag no catálogo do workspace sem etiquetar nada (para etiquetar use add-tag-to-entity). Se já existir uma tag com o mesmo nome no workspace, devolve a existente. Devolve o id da tag.

Parâmetro	Obrigatório	Descrição
`name`	sim	Nome da tag (ex.: "awb_nao_encontrado")
`color`	não	Cor em hex (padrão #64748b)
`workspaceId`	não	Opcional: precisa ser o workspace do token

`remove-tag-from-entity`

Remove tag de entidade específica. Verifica existência da associação antes de remover. Use para limpeza de tags.

Parâmetro	Obrigatório	Descrição
`entityType`	sim	Tipo da entidade (thread, agent, contact, rawContact)
`entityId`	sim	ID da entidade
`tagName`	não	Nome da tag a ser removida (alternativa ao tagId)
`tagId`	não	ID da tag a ser removida (alternativa ao tagName)

MCP: Funis, etapas e tags

`add-board-stage`

`add-contact-address`

`add-contact-channel`

`add-thread-member-agent`

`archive-thread`

`create-board`

`delete-board`

`delete-board-stage`

`delete-contact`

`duplicate-board`

`get-board`

`get-contact-details`

`get-thread`

`list-boards`

`list-organizations`

`remove-contact-address`

`remove-contact-channel`

`search-contacts`

`update-board`

`update-board-stage`

`update-contact-address`

`update-contact-channel`

`update-thread`

`list-workspace-stages`

`move-thread-to-stage`

`add-tag-to-entity`

`create-tag`

`remove-tag-from-entity`

Nesta página

MCP: Funis, etapas e tags

add-board-stageCopy Anchor Link

add-contact-addressCopy Anchor Link

add-contact-channelCopy Anchor Link

add-thread-member-agentCopy Anchor Link

archive-threadCopy Anchor Link

create-boardCopy Anchor Link

delete-boardCopy Anchor Link

delete-board-stageCopy Anchor Link

delete-contactCopy Anchor Link

duplicate-boardCopy Anchor Link

get-boardCopy Anchor Link

get-contact-detailsCopy Anchor Link

get-threadCopy Anchor Link

list-boardsCopy Anchor Link

list-organizationsCopy Anchor Link

remove-contact-addressCopy Anchor Link

remove-contact-channelCopy Anchor Link

search-contactsCopy Anchor Link

update-boardCopy Anchor Link

update-board-stageCopy Anchor Link

update-contact-addressCopy Anchor Link

update-contact-channelCopy Anchor Link

update-threadCopy Anchor Link

list-workspace-stagesCopy Anchor Link

move-thread-to-stageCopy Anchor Link

add-tag-to-entityCopy Anchor Link

create-tagCopy Anchor Link

remove-tag-from-entityCopy Anchor Link

Nesta página

`add-board-stage`

`add-contact-address`

`add-contact-channel`

`add-thread-member-agent`

`archive-thread`

`create-board`

`delete-board`

`delete-board-stage`

`delete-contact`

`duplicate-board`

`get-board`

`get-contact-details`

`get-thread`

`list-boards`

`list-organizations`

`remove-contact-address`

`remove-contact-channel`

`search-contacts`

`update-board`

`update-board-stage`

`update-contact-address`

`update-contact-channel`

`update-thread`

`list-workspace-stages`

`move-thread-to-stage`

`add-tag-to-entity`

`create-tag`

`remove-tag-from-entity`