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
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
contacts_search | contacts:read | leitura | query, email, phone, company, source, tag_ids, created_after, created_before, updated_after, updated_before, sort_by, sort_order, page, limit |
contacts_get | contacts:read | leitura | contact_id |
contacts_create | contacts:write | escrita | name, email, phone, company, title, location, linkedin_profile_url, source, custom_fields, tag_ids |
contacts_update | contacts:write | escrita | contact_id, name, email, phone, company, title, location, linkedin_profile_url, custom_fields |
contacts_add_tags | contacts:write | escrita | contact_id, tags, create_missing |
contacts_remove_tags | contacts:write | escrita | contact_id, tags |
contacts_add_note | contacts:write | escrita | contact_id, content |
Oportunidades
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
opportunities_search | opportunities:read | leitura | query, 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_get | opportunities:read | leitura | opportunity_id, include_history |
opportunities_create | opportunities:write | escrita | contact_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_update | opportunities:write | escrita | opportunity_id, title, value, score, notes, owner_user_id, sector_id, expected_close_date, probability, custom_fields |
opportunities_move_stage | opportunities:write | escrita | opportunity_id, stage_id, stage_name, pipeline_name, discard_reason_id, notes |
Conversas (inbox)
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
conversations_list | conversations:read | leitura | contact_id, opportunity_id, status, created_after, created_before, updated_after, updated_before, last_message_after, last_message_before, page, limit |
conversations_get | conversations:read | leitura | conversation_id, messages_limit |
conversations_send_message | conversations:write | escrita | conversation_id, content, pause_ai |
conversations_add_note | conversations:write | escrita | conversation_id, content |
conversations_take_control | conversations:write | escrita | conversation_id, reason |
conversations_transfer | conversations:write | escrita | conversation_id, sector_id, user_id |
Tarefas
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
tasks_search | tasks:read | leitura | query, 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_get | tasks:read | leitura | task_id, include_comments |
tasks_reference | tasks:read | leitura | |
tasks_create | tasks:write | escrita | title, 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_update | tasks:write | escrita | task_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_status | tasks:write | escrita | task_id, status |
tasks_add_comment | tasks:write | escrita | task_id, content, mentions |
Playbooks
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
playbooks_list | playbooks:read | leitura | query, include_inactive |
playbooks_get | playbooks:read | leitura | playbook_id |
playbook_runs_search | playbooks:read | leitura | query, playbook_id, status, overdue, contact_id, opportunity_id, started_after, started_before, page, limit |
playbook_runs_get | playbooks:read | leitura | run_id |
playbooks_start | playbooks:run | escrita | playbook_id, contact_id, opportunity_id, conversation_id, title, start_date, skip_weekends, timezone |
playbook_runs_cancel | playbooks:run | escrita (destrutiva) | run_id, reason |
playbook_runs_reschedule | playbooks:run | escrita | run_id |
Dados de referência
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
pipelines_list | pipelines:read | leitura | include_inactive |
pipelines_get | pipelines:read | leitura | pipeline_id |
tags_list | tags:read | leitura | |
users_list | users:read | leitura | role, is_active |
Relatórios
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
reports_funnel | reports:read | leitura | pipeline_id, sector_id |
reports_sales_summary | reports:read | leitura | pipeline_id, sector_id, owner_user_id, from, to |
Funcionários de IA
| Tool | Escopo | Tipo | Argumentos |
|---|---|---|---|
agents_list | agents:read | leitura | include_inactive |
agents_chat_start | agents:run | escrita | agent_id, lead_simulation |
agents_chat_send | agents:run | escrita | session_id, message, event |
agents_chat_end | agents:run | escrita (destrutiva) | session_id |
knowledge_search | knowledge:read | leitura | query, limit, type, agent_id, contact_id |
agent_register_lead_source | agent_tools:execute | escrita | source, campaign, adset, creative, contact_id |
agent_send_email | agent_tools:execute | escrita | subject, body, contact_id, agent_id |
agent_transfer_to_human | conversations:write | escrita | reason, farewell_message, agent_id, conversation_id, contact_id |
agent_schedule_meeting | agent_tools:execute | escrita | message_prefix, agent_id, conversation_id, contact_id |
agent_check_availability | agent_tools:execute | leitura | skip_days, agent_id, conversation_id, contact_id |
agent_book_meeting | agent_tools:execute | escrita | slot_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). Combineupdated_aftercomsort_by=updated_atpara sincronização incremental.contacts_create— exigenamee pelo menos um entreemail,phoneelinkedin_profile_url; contato com o mesmo e-mail devolveDUPLICATE_ERROR.contacts_update—custom_fieldssubstitui o objeto inteiro; etiquetas são gerenciadas porcontacts_add_tags/contacts_remove_tags.contacts_add_tags— nomes de etiqueta, sem diferenciar maiúsculas. Nome desconhecido devolveTAG_NOT_FOUND, a menos quecreate_missing: true(exigetags:write). Adicionar etiqueta dispara as mesmas automações do app (fluxos de e-mail, tracking).opportunities_create— passecontact_idpara vincular um contato existente, ouname/email/phone/companypara achar-ou-criar um (casado por e-mail). Sempipeline_id/stage_ido negócio entra na primeira etapa do funil padrão da conta. Semowner_user_ido rodízio da conta define o dono; o agente de entrada do funil é ativado como no app.opportunities_update—custom_fieldsfaz merge. Mudança de etapa é poropportunities_move_stage.opportunities_move_stage— porstage_idou porstage_name(o funil da própria oportunidade tem preferência; acrescentepipeline_namepara desempatar, senãoAMBIGUOUS). Grava histórico, marca ganho/perda e atualiza o Kanban em tempo real.conversations_list—statusé um deai_active,manual,closed; usearchived: true|falsepara 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_pausedno resultado diz se pausou de fato, compause_reasonquando não (ex.:already_manual,no_agent).conversations_take_control— statusmanual, IA pausada, follow-ups agendados cancelados, eventocontrol_takenregistrado. Libere o controle pelo inbox.conversations_transfer— sóuser_idatribui aquele usuário (setor não muda); sósector_idmove para o setor e o rodízio dele escolhe o usuário (assigned_via: round_robin;queue_empty: truequando 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ãoASSIGNEE_NOT_IN_SECTOR. Comdry_runo 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_idselabel_idssubstituem 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 destart_date, responsáveis como configurado em cada etapa. Comdry_run: truedevolve o prazo calculado de cada etapa sem criar nada. Precisa de contato, oportunidade, conversa outitle.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
| URI | Escopo | Conteúdo |
|---|---|---|
getraze://account | qualquer chave conectada | Id, nome e tipo da conta, módulos habilitados e escopos da chave |
getraze://pipelines | pipelines:read | Funis com etapas ordenadas |
getraze://tags | tags:read | Etiquetas com contagem de uso |
getraze://users | users:read | Membros da equipe |
getraze://sectors | sectors:read | Setores (times) |
getraze://agents | agents:read | Funcionários de IA com fluxo |
getraze://tool-catalog | agents:read | As tools nativas que um funcionário de IA pode usar, com JSON Schema |
Prompts
| Prompt | Argumentos | O que faz |
|---|---|---|
qualify_lead | contact_id, pipeline_name | Lê o contato, as conversas e as oportunidades e propõe etiquetas e mudança de etapa — sem executar |
daily_pipeline_review | pipeline_id, owner_user_id | Funil + últimos 7 dias + negócios parados, com três ações sugeridas |