MCP Tools
All tools available on the MCP server, grouped by domain. Bold arguments are required. Every write tool also accepts dry_run and idempotency_key (see conventions).
A key only sees the tools whose scope it has. Scopes marked admin only (conversations:write, agents:run, agent_tools:execute) can only be granted by an account administrator.
Contacts
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
contacts_search | contacts:read | read | 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 | read | contact_id |
contacts_create | contacts:write | write | name, email, phone, company, title, location, linkedin_profile_url, source, custom_fields, tag_ids |
contacts_update | contacts:write | write | contact_id, name, email, phone, company, title, location, linkedin_profile_url, custom_fields |
contacts_add_tags | contacts:write | write | contact_id, tags, create_missing |
contacts_remove_tags | contacts:write | write | contact_id, tags |
contacts_add_note | contacts:write | write | contact_id, content |
Opportunities
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
opportunities_search | opportunities:read | read | 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 | read | opportunity_id, include_history |
opportunities_create | opportunities:write | write | 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 | write | opportunity_id, title, value, score, notes, owner_user_id, sector_id, expected_close_date, probability, custom_fields |
opportunities_move_stage | opportunities:write | write | opportunity_id, stage_id, stage_name, pipeline_name, discard_reason_id, notes |
Conversations (inbox)
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
conversations_list | conversations:read | read | 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 | read | conversation_id, messages_limit |
conversations_send_message | conversations:write | write | conversation_id, content, pause_ai |
conversations_add_note | conversations:write | write | conversation_id, content |
conversations_take_control | conversations:write | write | conversation_id, reason |
conversations_transfer | conversations:write | write | conversation_id, sector_id, user_id |
Tasks
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
tasks_search | tasks:read | read | 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 | read | task_id, include_comments |
tasks_reference | tasks:read | read | |
tasks_create | tasks:write | write | 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 | write | 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 | write | task_id, status |
tasks_add_comment | tasks:write | write | task_id, content, mentions |
Playbooks
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
playbooks_list | playbooks:read | read | query, include_inactive |
playbooks_get | playbooks:read | read | playbook_id |
playbook_runs_search | playbooks:read | read | query, playbook_id, status, overdue, contact_id, opportunity_id, started_after, started_before, page, limit |
playbook_runs_get | playbooks:read | read | run_id |
playbooks_start | playbooks:run | write | playbook_id, contact_id, opportunity_id, conversation_id, title, start_date, skip_weekends, timezone |
playbook_runs_cancel | playbooks:run | write (destructive) | run_id, reason |
playbook_runs_reschedule | playbooks:run | write | run_id |
Reference data
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
pipelines_list | pipelines:read | read | include_inactive |
pipelines_get | pipelines:read | read | pipeline_id |
tags_list | tags:read | read | |
users_list | users:read | read | role, is_active |
Reports
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
reports_funnel | reports:read | read | pipeline_id, sector_id |
reports_sales_summary | reports:read | read | pipeline_id, sector_id, owner_user_id, from, to |
AI employees
| Tool | Scope | Kind | Arguments |
|---|---|---|---|
agents_list | agents:read | read | include_inactive |
agents_chat_start | agents:run | write | agent_id, lead_simulation |
agents_chat_send | agents:run | write | session_id, message, event |
agents_chat_end | agents:run | write (destructive) | session_id |
knowledge_search | knowledge:read | read | query, limit, type, agent_id, contact_id |
agent_register_lead_source | agent_tools:execute | write | source, campaign, adset, creative, contact_id |
agent_send_email | agent_tools:execute | write | subject, body, contact_id, agent_id |
agent_transfer_to_human | conversations:write | write | reason, farewell_message, agent_id, conversation_id, contact_id |
agent_schedule_meeting | agent_tools:execute | write | message_prefix, agent_id, conversation_id, contact_id |
agent_check_availability | agent_tools:execute | read | skip_days, agent_id, conversation_id, contact_id |
agent_book_meeting | agent_tools:execute | write | slot_id, title, agent_id, contact_id, conversation_id |
Notes per tool
contacts_search/opportunities_search—queryis a free-text partial match (name, email, company / title, contact). Combineupdated_afterwithsort_by=updated_atfor incremental sync.contacts_create— needsnameplus at least one ofemail,phoneorlinkedin_profile_url; a contact with the same email returnsDUPLICATE_ERROR.contacts_update—custom_fieldsreplaces the whole object; tags are managed withcontacts_add_tags/contacts_remove_tags.contacts_add_tags— tag names, matched case-insensitively. Unknown names returnTAG_NOT_FOUNDunlesscreate_missing: true(requirestags:write). Adding a tag fires the same automations as in the app (email flows, tracking).opportunities_create— passcontact_idto link an existing contact, orname/email/phone/companyto find-or-create one (matched by email). Withoutpipeline_id/stage_idthe deal lands in the first stage of the account default pipeline. Withoutowner_user_idthe account round-robin assigns an owner; the pipeline entry AI agent is activated as in the app.opportunities_update—custom_fieldsare merged. Stage changes go throughopportunities_move_stage.opportunities_move_stage— bystage_id, or bystage_name(the opportunity's own pipeline is preferred; addpipeline_nameto disambiguate, elseAMBIGUOUS). Records history, sets won/lost timestamps and refreshes the Kanban in real time.conversations_list—statusis one ofai_active,manual,closed; usearchived: true|falseto filter archived conversations.conversations_send_message— text only; sends through the conversation channel (WhatsApp, LinkedIn, Instagram, email, webchat). By default it pauses the AI employee on that conversation (pause_ai);ai_pausedin the result says whether it actually did, withpause_reasonotherwise (e.g.already_manual,no_agent).conversations_take_control— statusmanual, AI paused, scheduled follow-ups cancelled,control_takenevent recorded. Release control from the inbox.conversations_transfer—user_idonly assigns that user (sector unchanged);sector_idonly moves to the sector and its round-robin picks the user (assigned_via: round_robin;queue_empty: truewhen nobody is in the queue); both moves and assigns that user without touching the round-robin. The user must be a member of the target sector, otherwiseASSIGNEE_NOT_IN_SECTOR. Withdry_runthe round-robin is only peeked. Same rules as Transfer Conversation. It does not pause the AI employee.tasks_*/playbooks_*— the key sees what the user who created it sees in the app (admins see everything; other users their own work), and writes are authored by that user. Same rules as the Tasks and Playbooks endpoints.tasks_update—assignee_idsandlabel_idsreplace the current lists. The contact/opportunity of a task cannot change.tasks_set_status— completing a recurring task creates the next occurrence (next_occurrence_id); completing a playbook step advances its run. Steps of a cancelled run cannot change.playbooks_start— one task per step, due dates chained fromstart_date, assignees as configured in each step. Withdry_run: trueit returns the computed due date of every step without creating anything. Needs a contact, opportunity, conversation ortitle.reports_*— same definitions as the in-app reports: active = not lost/discarded, won = active in a win stage.- AI-employee tools are described on the AI employees page.
Resources
| URI | Scope | Content |
|---|---|---|
getraze://account | any connected key | Account id, name, type, enabled modules and the key's scopes |
getraze://pipelines | pipelines:read | Pipelines with ordered stages |
getraze://tags | tags:read | Tags with usage counts |
getraze://users | users:read | Team members |
getraze://sectors | sectors:read | Sectors (teams) |
getraze://agents | agents:read | Flow-based AI employees |
getraze://tool-catalog | agents:read | The native tools an AI employee can use, with JSON Schema |
Prompts
| Prompt | Arguments | What it does |
|---|---|---|
qualify_lead | contact_id, pipeline_name | Reads the contact, its conversations and opportunities, then proposes tags and a stage move — without executing them |
daily_pipeline_review | pipeline_id, owner_user_id | Funnel + last 7 days + stale open deals, with three suggested actions |