Documentation Index
Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt
Use this file to discover all available pages before exploring further.
Breakcold MCP exposes tools generated from the same public API contract as the REST API. Each tool call uses the same permissions, token cost, and rate limits as the matching API route.
Discovery
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
tools_search | Search available Breakcold MCP tools by name, description, capability, or required scope. | Authenticated | 0 tokens | MCP session authenticated |
capabilities_list | List Breakcold MCP capabilities, granted scopes, and the tools available in each capability group. | Authenticated | 0 tokens | MCP session authenticated |
Workspaces
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
workspaces_list | List workspaces the authenticated Breakcold actor can access. | Authenticated | 0 tokens | 120 requests/min per tool/org |
CRM
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
crm_objects_list | List CRM object types in a workspace. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_objects_create | Create a custom CRM object type. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_objects_reorder | Reorder CRM object types. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_objects_get | Fetch one CRM object type. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_objects_update | Update CRM object metadata. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_objects_delete | Delete a custom CRM object type. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_fields_list | List CRM field definitions. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_fields_create | Create a CRM field definition. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_fields_reorder | Reorder CRM fields. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_fields_get | Fetch one CRM field definition. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_fields_update | Update a CRM field definition. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_fields_delete | Delete a custom CRM field definition. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_field_options_list | List CRM field options. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_field_options_create | Create a CRM field option. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_field_options_reorder | Reorder CRM field options. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_field_options_update | Update a CRM field option. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_field_options_delete | Delete a CRM field option. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_record_views_list | List CRM record views. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_record_views_create | Create a CRM record view. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_record_views_reorder | Reorder CRM record views. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_record_views_get | Fetch one CRM record view. | crm:metadata:read | 0 tokens | 120 requests/min per tool/org |
crm_record_views_update | Update a CRM record view and replace its saved config. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
crm_record_views_delete | Delete a CRM record view. | crm:metadata:write | 0 tokens | 120 requests/min per tool/org |
Records
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
records_list | List or search CRM records. | records:read | 0 tokens | 120 requests/min per tool/org |
records_create | Create a CRM record. | records:write | 0 tokens | 120 requests/min per tool/org |
records_get | Fetch a CRM record by ID. | records:read | 0 tokens | 120 requests/min per tool/org |
records_update | Update CRM record field values. | records:write | 0 tokens | 120 requests/min per tool/org |
records_archive | Archive a CRM record. | records:write | 0 tokens | 120 requests/min per tool/org |
records_restore | Restore an archived CRM record. | records:write | 0 tokens | 120 requests/min per tool/org |
custom_activities_create | Create a custom activity linked to a CRM record. | records:write | 0 tokens | 120 requests/min per tool/org |
Tasks
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
tasks_list | List tasks linked to a record. | tasks:read | 0 tokens | 120 requests/min per tool/org |
tasks_create | Create a task linked to a record. | tasks:write | 0 tokens | 120 requests/min per tool/org |
tasks_update | Update task details. | tasks:write | 0 tokens | 120 requests/min per tool/org |
tasks_complete | Mark a task as done. | tasks:write | 0 tokens | 120 requests/min per tool/org |
Notes
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
notes_list | List notes linked to a record. | notes:read | 0 tokens | 120 requests/min per tool/org |
notes_create | Create a note linked to a record. | notes:write | 0 tokens | 120 requests/min per tool/org |
notes_get | Fetch a note by ID. | notes:read | 0 tokens | 120 requests/min per tool/org |
notes_update | Update note content. | notes:write | 0 tokens | 120 requests/min per tool/org |
Inbox
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
inbox_views_list | List visible inbox views. | inbox:views:read | 0 tokens | 120 requests/min per tool/org |
inbox_views_create | Create an inbox view. | inbox:views:write | 0 tokens | 120 requests/min per tool/org |
inbox_views_sidebar_get | Fetch inbox view sidebar layout. | inbox:views:read | 0 tokens | 120 requests/min per tool/org |
inbox_views_sidebar_reorder | Reorder inbox view sidebar items. | inbox:views:write | 0 tokens | 120 requests/min per tool/org |
inbox_views_get | Fetch one inbox view. | inbox:views:read | 0 tokens | 120 requests/min per tool/org |
inbox_views_update | Update an inbox view and replace its saved config. | inbox:views:write | 0 tokens | 120 requests/min per tool/org |
inbox_views_delete | Delete an inbox view. | inbox:views:write | 0 tokens | 120 requests/min per tool/org |
inbox_conversations_search | List or search inbox conversations in a workspace, optionally filtered by inbox view or record-link state. | inbox:read | 0 tokens | 120 requests/min per tool/org |
inbox_conversations_list | List conversations linked to a record. | inbox:read | 0 tokens | 120 requests/min per tool/org |
inbox_messages_list | List messages for a conversation. | inbox:read | 0 tokens | 120 requests/min per tool/org |
inbox_messages_get | Fetch one inbox message. | inbox:read | 0 tokens | 120 requests/min per tool/org |
Meetings
| Tool | What it does | Required scope | Token cost | Rate limit |
|---|
meetings_list | List workspace meetings with recording and transcript metadata. | meetings:read | 0 tokens | 120 requests/min per tool/org |
meetings_get | Fetch one meeting with recording and transcript metadata. | meetings:read | 0 tokens | 120 requests/min per tool/org |
meetings_transcript_list | List full meeting transcript text in ordered paginated segments. | meetings:read | 0 tokens | 120 requests/min per tool/org |
