Skip to content

Tools do MCP ​

Todas as tools do servidor MCP, agrupadas por domínio. Argumentos em negrito são obrigatórios. Toda tool de escrita (write) aceita também dry_run e idempotency_key (veja as convenções).

Uma chave só enxerga as tools cujo escopo ela tem. Os escopos conversations:write, agents:run e agent_tools:execute só podem ser concedidos por um administrador da conta.

Contatos ​

ToolEscopoTipoArgumentos
contacts_searchcontacts:readleituraquery, email, phone, company, source, tag_ids, created_after, created_before, updated_after, updated_before, sort_by, sort_order, page, limit
contacts_getcontacts:readleituracontact_id
contacts_createcontacts:writeescritaname, email, phone, company, title, location, linkedin_profile_url, source, custom_fields, tag_ids
contacts_updatecontacts:writeescritacontact_id, name, email, phone, company, title, location, linkedin_profile_url, custom_fields
contacts_add_tagscontacts:writeescritacontact_id, tags, create_missing
contacts_remove_tagscontacts:writeescritacontact_id, tags
contacts_add_notecontacts:writeescritacontact_id, content

Oportunidades ​

ToolEscopoTipoArgumentos
opportunities_searchopportunities:readleituraquery, pipeline_id, stage_id, owner_user_id, contact_id, campaign_id, company, created_after, created_before, updated_after, updated_before, sort_by, sort_order, page, limit
opportunities_getopportunities:readleituraopportunity_id, include_history
opportunities_createopportunities:writeescritacontact_id, name, email, phone, company, title, pipeline_id, stage_id, value, score, notes, owner_user_id, sector_id, campaign_id, source, custom_fields, activate_agent_id, enroll_in_flow_id
opportunities_updateopportunities:writeescritaopportunity_id, title, value, score, notes, owner_user_id, sector_id, expected_close_date, probability, custom_fields
opportunities_move_stageopportunities:writeescritaopportunity_id, stage_id, stage_name, pipeline_name, discard_reason_id, notes

Conversas (inbox) ​

ToolEscopoTipoArgumentos
conversations_listconversations:readleituracontact_id, opportunity_id, status, created_after, created_before, updated_after, updated_before, last_message_after, last_message_before, page, limit
conversations_getconversations:readleituraconversation_id, messages_limit
conversations_send_messageconversations:writeescritaconversation_id, content, pause_ai
conversations_add_noteconversations:writeescritaconversation_id, content
conversations_take_controlconversations:writeescritaconversation_id, reason
conversations_transferconversations:writeescritaconversation_id, sector_id, user_id

Tarefas ​

ToolEscopoTipoArgumentos
tasks_searchtasks:readleituraquery, status, assignee_id, contact_id, opportunity_id, playbook_run_id, task_pipeline_id, task_type, priority, overdue, due_after, due_before, updated_after, sort_by, sort_order, page, limit
tasks_gettasks:readleituratask_id, include_comments
tasks_referencetasks:readleitura
tasks_createtasks:writeescritatitle, opportunity_id, contact_id, status, description, task_type, priority, due_date, end_date, assignee_ids, label_ids, task_pipeline_id, size, estimate_hours, reminder_minutes_before, recurrence
tasks_updatetasks:writeescritatask_id, title, status, description, task_type, priority, due_date, end_date, assignee_ids, label_ids, task_pipeline_id, size, estimate_hours, reminder_minutes_before, recurrence
tasks_set_statustasks:writeescritatask_id, status
tasks_add_commenttasks:writeescritatask_id, content, mentions

Playbooks ​

ToolEscopoTipoArgumentos
playbooks_listplaybooks:readleituraquery, include_inactive
playbooks_getplaybooks:readleituraplaybook_id
playbook_runs_searchplaybooks:readleituraquery, playbook_id, status, overdue, contact_id, opportunity_id, started_after, started_before, page, limit
playbook_runs_getplaybooks:readleiturarun_id
playbooks_startplaybooks:runescritaplaybook_id, contact_id, opportunity_id, conversation_id, title, start_date, skip_weekends, timezone
playbook_runs_cancelplaybooks:runescrita (destrutiva)run_id, reason
playbook_runs_rescheduleplaybooks:runescritarun_id

Dados de referência ​

ToolEscopoTipoArgumentos
pipelines_listpipelines:readleiturainclude_inactive
pipelines_getpipelines:readleiturapipeline_id
tags_listtags:readleitura
users_listusers:readleiturarole, is_active

Relatórios ​

ToolEscopoTipoArgumentos
reports_funnelreports:readleiturapipeline_id, sector_id
reports_sales_summaryreports:readleiturapipeline_id, sector_id, owner_user_id, from, to

Funcionários de IA ​

ToolEscopoTipoArgumentos
agents_listagents:readleiturainclude_inactive
agents_chat_startagents:runescritaagent_id, lead_simulation
agents_chat_sendagents:runescritasession_id, message, event
agents_chat_endagents:runescrita (destrutiva)session_id
knowledge_searchknowledge:readleituraquery, limit, type, agent_id, contact_id
agent_register_lead_sourceagent_tools:executeescritasource, campaign, adset, creative, contact_id
agent_send_emailagent_tools:executeescritasubject, body, contact_id, agent_id
agent_transfer_to_humanconversations:writeescritareason, farewell_message, agent_id, conversation_id, contact_id
agent_schedule_meetingagent_tools:executeescritamessage_prefix, agent_id, conversation_id, contact_id
agent_check_availabilityagent_tools:executeleituraskip_days, agent_id, conversation_id, contact_id
agent_book_meetingagent_tools:executeescritaslot_id, title, agent_id, contact_id, conversation_id

Notas por tool ​

  • contacts_search / opportunities_search — query é busca parcial em texto livre (nome, e-mail, empresa / título, contato). Combine updated_after com sort_by=updated_at para sincronização incremental.
  • contacts_create — exige name e pelo menos um entre email, phone e linkedin_profile_url; contato com o mesmo e-mail devolve DUPLICATE_ERROR.
  • contacts_update — custom_fields substitui o objeto inteiro; etiquetas são gerenciadas por contacts_add_tags / contacts_remove_tags.
  • contacts_add_tags — nomes de etiqueta, sem diferenciar maiúsculas. Nome desconhecido devolve TAG_NOT_FOUND, a menos que create_missing: true (exige tags:write). Adicionar etiqueta dispara as mesmas automações do app (fluxos de e-mail, tracking).
  • opportunities_create — passe contact_id para vincular um contato existente, ou name/email/phone/company para achar-ou-criar um (casado por e-mail). Sem pipeline_id/stage_id o negócio entra na primeira etapa do funil padrão da conta. Sem owner_user_id o rodízio da conta define o dono; o agente de entrada do funil é ativado como no app.
  • opportunities_update — custom_fields faz merge. Mudança de etapa é por opportunities_move_stage.
  • opportunities_move_stage — por stage_id ou por stage_name (o funil da própria oportunidade tem preferência; acrescente pipeline_name para desempatar, senão AMBIGUOUS). Grava histórico, marca ganho/perda e atualiza o Kanban em tempo real.
  • conversations_list — status é um de ai_active, manual, closed; use archived: true|false para filtrar arquivadas.
  • conversations_send_message — só texto; envia pelo canal da conversa (WhatsApp, LinkedIn, Instagram, e-mail, webchat). Por padrão pausa o funcionário de IA daquela conversa (pause_ai); ai_paused no resultado diz se pausou de fato, com pause_reason quando não (ex.: already_manual, no_agent).
  • conversations_take_control — status manual, IA pausada, follow-ups agendados cancelados, evento control_taken registrado. Libere o controle pelo inbox.
  • conversations_transfer — só user_id atribui aquele usuário (setor não muda); só sector_id move para o setor e o rodízio dele escolhe o usuário (assigned_via: round_robin; queue_empty: true quando não há ninguém na fila); os dois movem e atribuem aquele usuário sem tocar no rodízio. O usuário precisa ser do setor de destino, senão ASSIGNEE_NOT_IN_SECTOR. Com dry_run o rodízio só é espiado. Mesmas regras de Transferir Conversa. Não pausa o funcionário de IA.
  • tasks_* / playbooks_* — a chave vê o que o usuário que a criou vê no app (administradores veem tudo; os demais, o próprio trabalho), e as escritas ficam no nome desse usuário. Mesmas regras dos endpoints de Tarefas e Playbooks.
  • tasks_update — assignee_ids e label_ids substituem as listas atuais. O contato/oportunidade de uma tarefa não muda.
  • tasks_set_status — concluir uma tarefa recorrente cria a próxima ocorrência (next_occurrence_id); concluir uma etapa de playbook avança a execução. Etapas de execução cancelada não mudam.
  • playbooks_start — uma tarefa por etapa, prazos encadeados a partir de start_date, responsáveis como configurado em cada etapa. Com dry_run: true devolve o prazo calculado de cada etapa sem criar nada. Precisa de contato, oportunidade, conversa ou title.
  • reports_* — mesmas definições dos relatórios do app: ativa = não perdida/descartada, ganha = ativa numa etapa de ganho.
  • As tools de funcionários de IA estão descritas na página Funcionários de IA.

Resources ​

URIEscopoConteúdo
getraze://accountqualquer chave conectadaId, nome e tipo da conta, módulos habilitados e escopos da chave
getraze://pipelinespipelines:readFunis com etapas ordenadas
getraze://tagstags:readEtiquetas com contagem de uso
getraze://usersusers:readMembros da equipe
getraze://sectorssectors:readSetores (times)
getraze://agentsagents:readFuncionários de IA com fluxo
getraze://tool-catalogagents:readAs tools nativas que um funcionário de IA pode usar, com JSON Schema

Prompts ​

PromptArgumentosO que faz
qualify_leadcontact_id, pipeline_nameLê o contato, as conversas e as oportunidades e propõe etiquetas e mudança de etapa — sem executar
daily_pipeline_reviewpipeline_id, owner_user_idFunil + últimos 7 dias + negócios parados, com três ações sugeridas

GetRaze - AI-Powered Lead Generation