Tools Reference

The Metadot MCP server provides 315 registered tools across 15 app modules, including two retired SOP tools that return upgrade guidance. Each connection is bound to one workspace, so tools do not take a workspace_id; call current_workspace to inspect the active workspace.

Summary

Module	Tools	Read	Write	App ID
Common (whoami, search, workspaces, members)	5	5	0	—
Tags, comments, attachments (any supported record)	10	3	7	—
Trash (restore across apps)	2	1	1	—
CRM (contacts, companies, leads, activities, pipelines)	30	14	16	crm
Tickets	26	11	15	tickets
Stackr (kanban boards, lists, cards)	34	10	24	stackr
Assets	22	12	10	assets
BookMe (calendars, bookings)	27	10	17	bookme
InvoiceMe (invoices, customers)	40	13	27	invoiceme
Knowledge Base (articles, categories)	20	5	15	knowledge
Inventory (items, transactions)	12	5	7	inventory
Suppliers	14	5	9	suppliers
Changelog (entries, topics)	16	5	11	changelog
Workflows (automations, executions)	12	5	7	workflows
Polls	19	4	15	polls
Forms	2	2	0	—
Reports	8	3	5	reports
SOPs	16	8	8	sops
Total	315	121	194

Common Tools

These tools are always available regardless of which apps are enabled.

Tool	Description
whoami	Returns information about the authenticated user and API key
current_workspace	Returns the workspace this MCP connection is bound to (id, slug, name, role, enabled apps).
search	Full-text search across all modules in the connected workspace.
workspace_members_search	Find human members of the connected workspace by name or email fragment.
teams_list	List the teams of the connected workspace (id, name, description, color).

CRM

Tool	Type	Description
crm_search_members	read	Find workspace members by name or email to get the user ID for owner_id / assigned_to / assignee_id in the CRM…
crm_search_contacts	read	Search CRM contacts by name, email, or phone (trashed: true lists deleted contacts).
crm_get_contact	read	Get a single CRM contact by ID with full details.
crm_create_contact	write	Create a new CRM contact.
crm_update_contact	write	Update an existing CRM contact.
crm_delete_contact	write	Move a CRM contact to the trash.
crm_restore_contact	write	Bring a deleted CRM contact back from the trash.
crm_search_companies	read	Search CRM companies by name or domain (trashed: true lists deleted companies).
crm_get_company	read	Get a single CRM company by ID.
crm_create_company	write	Create a new CRM company.
crm_update_company	write	Update a CRM company.
crm_delete_company	write	Move a CRM company to the trash.
crm_restore_company	write	Bring a deleted CRM company back from the trash.
crm_search_leads	read	Search CRM leads.
crm_get_lead	read	Get a single CRM lead by ID.
crm_create_lead	write	Create a new CRM lead in a pipeline.
crm_update_lead	write	Update a CRM lead's details.
crm_qualify_lead	write	Qualify a new lead: converts it into a CRM contact plus an open opportunity in one step (the lead becomes…
crm_dismiss_lead	write	Dismiss a new CRM lead (drops it from the inbox), or set restore=true to bring a dismissed lead back to new.
crm_search_activities	read	Search CRM activities (calls, meetings, emails, tasks, etc.).
crm_list_my_activities	read	List CRM activities owned by the authenticated user.
crm_list_activity_types	read	List the workspace's CRM activity types (e.g. call, meeting, task).
crm_create_activity	write	Create a new CRM activity (call, meeting, email, task, ...).
crm_update_activity	write	Update a CRM activity: complete a task (status=done), reschedule (due_date), retitle, retype, relink or…
crm_delete_activity	write	DESTRUCTIVE: delete a CRM activity (call, meeting, task, ...).
crm_list_pipelines	read	List CRM pipelines in the workspace that the caller has been granted access to.
crm_list_stages	read	List all stages in a CRM pipeline.
crm_search_opportunities	read	Search CRM opportunities/deals (trashed: true lists deleted deals).
crm_get_opportunity	read	Get a single CRM opportunity by ID.
crm_create_opportunity	write	Create a new CRM opportunity/deal.
crm_update_opportunity	write	Update a CRM opportunity/deal: fields, status (open/won/lost/abandoned), owner, contact/company links, and stage.
crm_delete_opportunity	write	Move a CRM opportunity/deal to the trash.
crm_restore_opportunity	write	Bring a deleted CRM opportunity/deal back from the trash.

Tickets

Tool	Type	Description
tickets_list	read	List helpdesk tickets.
tickets_get	read	Get a single ticket by ID with full details including messages.
tickets_list_mine	read	List helpdesk tickets assigned to the authenticated user.
tickets_list_statuses	read	List the valid ticket status values accepted by tickets_list, tickets_create, and tickets_update.
tickets_list_custom_fields	read	List ticket custom-field definitions, keys, types, options and requiredness before creating a ticket.
tickets_search_assignees	read	Find workspace members by name or email to get the user ID for assignee_id in tickets_create / tickets_update.
tickets_list_queues	read	List the ticket queues you can access, to get the queue_id for tickets_create / tickets_update.
tickets_create	write	Create a new helpdesk ticket.
tickets_update	write	Update an existing ticket: subject, description, priority, custom fields, status, assignee (assignee_id, null…
tickets_bulk_update	write	Change up to 500 tickets at once: status (tickets_list_statuses), priority, assignee (assignee_id, null…
tickets_mark_read	write	Mark a ticket as read for YOU (your personal unread badge; nobody else is affected).
tickets_mark_unread	write	Mark a ticket as unread for YOU (your personal unread badge; nobody else is affected).
tickets_list_views	read	List the saved ticket views you can use: your own plus views shared with the workspace (queue-scoped views only…
tickets_save_view	write	Save a ticket list view (a named set of filters), or update one of YOUR OWN views by passing view_id (see…
tickets_delete_view	write	Delete one of YOUR OWN saved ticket views (ids from tickets_list_views).
tickets_add_message	write	Add a message/reply to an existing ticket.
tickets_list_canned_responses	read	List the workspace's canned (saved) replies, optionally filtered by title.
tickets_update_message	write	Edit the body of one of YOUR OWN ticket messages (replies and notes; system messages cannot be edited).
tickets_delete_message	write	Permanently delete one of YOUR OWN ticket messages (system messages cannot be deleted).
tickets_list_tags	read	List ticket tags you can apply: the workspace-level tags, plus the queue-local tags of queue_id when given (see…
tickets_add_tag	write	Add a tag to a ticket.
tickets_remove_tag	write	Remove a tag from a ticket (tag ids are on the ticket in tickets_get, or see tickets_list_tags).
tickets_list_participants	read	List a ticket's active participants (requester, CC and inbound-CC addresses) with the participant ids used by…
tickets_update_cc	write	Add and/or remove CC email addresses on a ticket (they receive public replies).
tickets_remove_participant	write	Remove one CC / inbound-CC participant from a ticket (ids from tickets_list_participants).
tickets_link_stackr	write	Link a ticket to an existing Stackr card (card_id, see stackr_get_cards) or project/board (board_id, see…
tickets_list_forms	read	List ticket intake forms (id, name, default/active flags, field count); pass include_inactive for drafts.
tickets_get_form	read	Get one intake form in canonical shape (fields, system-field mapping, options, conditions, provenance).
tickets_create_custom_field	write	Create ONE ticket custom field from a canonical descriptor; reuses an existing field by key (or label+type).
tickets_create_form	write	Import an intake form + missing custom fields (e.g. from Mojo). Dry-run by default; idempotent on (source, id).

Before calling tickets_create, use tickets_list_custom_fields and supply any required values in custom_fields, keyed by field key. tickets_update accepts the same map for changes; a null value clears that field, subject to validation. On creation, omitted requester_id defaults to the calling human member; agent callers default to no requester. Pass null explicitly to leave it unset, or a workspace-member user ID to select a requester. To assign, pass assignee_id to tickets_create / tickets_update (null unassigns); find IDs with tickets_search_assignees and queue IDs with tickets_list_queues. tickets_update also takes status, due_at (ISO-8601, null clears) and queue_id (null moves to the triage inbox), all validated before anything is written.

To recreate an intake form from another helpdesk (e.g. Mojo), call tickets_create_form with dry_run: true first and show the returned plan (fields to create, fields to reuse, system-field mappings, warnings) before running for real with dry_run: false. It is idempotent on (source, source_id) — a re-run returns the existing form (already_exists: true) and writes nothing unless update_existing: true. Unsupported source field types fall back to the closest supported type with a warning, or abort under strict: true; is_default never replaces an existing default form unless replace_default: true. Both tickets_create_form and tickets_create_custom_field require ticket-manage permission.

Stackr

Tool	Type	Description
stackr_list_boards	read	List the Stackr boards the caller can access (trashed: true lists the trash they maintain).
stackr_get_board	read	Get a single Stackr board by ID.
stackr_create_board	write	Create a new Stackr board (project).
stackr_get_lists	read	Get all lists in a Stackr board.
stackr_create_list	write	Create a new list in a Stackr board.
stackr_get_cards	read	Get all cards (tasks) in a Stackr list.
stackr_get_card	read	Get a single Stackr card (task) by ID, including its checklists (with items) and tags.
stackr_create_card	write	Create a new card (task) in a Stackr list.
stackr_move_card	write	Move a Stackr card to a different list and/or position.
stackr_update_card	write	Edit a Stackr card: title, description, assignee (a workspace member; null unassigns), start/due dates (ISO;…
stackr_delete_card	write	DESTRUCTIVE: permanently delete a Stackr card with its checklists, comments and attachments.
stackr_list_card_comments	read	List the comments on a Stackr card, oldest first (author, content, parent comment for replies).
stackr_add_card_comment	write	Add a comment (or a reply) to a Stackr card.
stackr_add_checklist	write	Add a checklist to a Stackr card.
stackr_add_checklist_item	write	Add an item to a Stackr checklist, optionally assigned to a workspace member (notified, and shown in their My…
stackr_update_checklist_item	write	Update a Stackr checklist item: tick or untick it (completed), rename it, reassign it (workspace member; null…
stackr_search_assignees	read	Find people to assign on a Stackr board by name or email.
stackr_list_board_tags	read	List the tags (labels) defined on a Stackr board: id, name, color.
stackr_add_card_tag	write	Add a tag to a Stackr card.
stackr_remove_card_tag	write	Remove a tag from a Stackr card.
stackr_update_list	write	Rename a Stackr list and/or change its kind: normal, done (a card moved in is completed, and every open card…
stackr_archive_list	write	Archive a Stackr list (hides it and its cards from the board; a maintainer can unarchive it in the app, nothi…
stackr_delete_list	write	DESTRUCTIVE: permanently delete a Stackr list together with every card in it (checklists, comments and…
stackr_update_board	write	Edit a Stackr board's settings: title, description (null clears), status (backlog, planned, in_progress,…
stackr_archive_board	write	Archive a Stackr board (read-only; its recurring schedules pause; nothing is deleted) or, with archived=false,…
stackr_duplicate_board	write	Duplicate a Stackr board (lists, labels, and by default its cards and checklists) into a NEW board you maintain.
stackr_delete_board	write	Move a Stackr board to the trash (nothing is destroyed).
stackr_restore_board	write	Bring a Stackr board back from the trash (archived again if it was archived before).
stackr_create_board_tag	write	Create a card label (tag) on a Stackr board so cards can be tagged with it (stackr_add_card_tag).
stackr_update_board_tag	write	Rename and/or recolor a card label on a Stackr board.
stackr_delete_board_tag	write	DESTRUCTIVE: delete a card label from a Stackr board; it is removed from every card that carries it.
stackr_list_project_tags	read	List the workspace's project-tag palette (id, name, color): the tags that can be attached to a whole board.
stackr_list_board_members	read	List who has access to a Stackr board and at what level (viewer, editor, maintainer): people, teams and…
stackr_share_board	write	Share a Stackr board: give one workspace member or one team viewer, editor or maintainer access, or give…
stackr_unshare_board	write	Remove someone's access to a Stackr board (a workspace member, a team, or the workspace-wide sharing).

Assets

Tool	Type	Description
assets_search	read	Search assets by name, tag, serial number or notes, with optional filters (status, location_id, category_id,…
assets_get	read	Get a single asset by ID with full details.
assets_get_by_tag	read	Look up one asset by its asset tag or serial number (exact match first, then partial) — the scanner workflow.
assets_create	write	Create a new asset.
assets_update	write	Update an existing asset.
assets_check_out	write	Check an asset out to a person (a workspace member).
assets_check_in	write	Check an asset back in (closes its active checkout).
assets_list_checkouts	read	List asset checkouts (who has what), newest first.
assets_transfer	write	Move an asset to another location.
assets_bulk_update	write	Change the status and/or location of many assets in one call (up to 200).
assets_bulk_check_out	write	Check out many assets to one person (a workspace member) in one call (up to 200).
assets_bulk_check_in	write	Check many assets back in in one call (up to 200), closing each one's active checkout.
assets_list_contracts	read	List asset contracts (warranties, support, leases, licences) newest-name first, with vendor, type, dates, cost…
assets_get_contract	read	Get one asset contract by ID (assets_list_contracts) with its vendor, type, dates, cost, notes and the assets…
assets_list_contract_types	read	List the workspace's active contract types (id, name, slug, description).
assets_list_custom_fields	read	List the asset custom-field definitions (key, label, type, select options, required flag).
assets_create_contract	write	Create an asset contract (warranty, support agreement, lease, licence).
assets_update_contract	write	Update an asset contract.
assets_list_locations	read	List asset locations (id, name, type, parent) you have access to.
assets_list_models	read	List asset models (id, manufacturer, model name, category).
assets_list_categories	read	List asset categories (id, name, parent).
assets_search_people	read	Find workspace members by name or email (up to 10).

BookMe

Tool	Type	Description
bookme_list_calendars	read	List booking calendars the caller has been granted access to, with stats (upcoming/past booking counts).
bookme_get_calendar	read	Get a single booking calendar by ID with full details.
bookme_list_bookings	read	List bookings, newest first, with pagination.
bookme_get_availability	read	List the bookable time slots of a calendar for a date range (the same slots the public booking page offers:…
bookme_get_booking	read	Get a single booking by ID with full details.
bookme_create_booking	write	Create a new booking on a calendar.
bookme_reschedule_booking	write	Move a scheduled one-to-one booking to a new start time (the end follows the calendar's duration).
bookme_mark_booking	write	Record what happened at a finished booking: outcome no_show (the guest did not come) or attended.
bookme_cancel_booking	write	Cancel a scheduled booking by ID (bookme_list_bookings gives ids).
bookme_create_calendar	write	Create a booking calendar (a public booking page).
bookme_update_calendar	write	Change a booking calendar's settings: title, slug, description, duration, buffer, minimum notice, booking…
bookme_delete_calendar	write	PERMANENTLY delete a booking calendar with all its bookings, invitation links and history.
bookme_list_links	read	List a booking calendar's expiring invitation links (bookme_list_calendars gives calendar ids): name, note,…
bookme_create_link	write	Create an expiring invitation link for a booking calendar: anyone holding the URL can book (within its limit…
bookme_update_link	write	Change an invitation link's name, note, expiry, booking limit or meeting-date bounds (send only what changes;…
bookme_revoke_link	write	Revoke an invitation link so it stops accepting bookings.
bookme_list_calendar_access	read	List who can open a booking calendar and at what level (viewer, editor, maintainer): people and workspace-wide…
bookme_share_calendar	write	Share a booking calendar: give one workspace member viewer, editor or maintainer access, or give everyone in…
bookme_unshare_calendar	write	Remove someone's access to a booking calendar (a workspace member, or the workspace-wide sharing).
bookme_transfer_calendar	write	Hand a booking calendar you OWN to another workspace member (the new owner must be an active member who can…
bookme_claim_calendar	write	Take over a booking calendar whose owner is no longer an active workspace member who can manage BookMe.
bookme_list_orphaned_calendars	read	Workspace owners and admins only: list booking calendars nobody can manage any more (their owner left or lost…
bookme_reassign_orphaned_calendar	write	Workspace owners and admins only: give a booking calendar that NOBODY can manage a new owner (an active member…
bookme_list_folders	read	List the calendar folders you can see: folders you have access to, plus folders holding a calendar you can open…
bookme_move_calendar	write	Move a booking calendar into a folder, or out of its folder (folder_id null).
bookme_list_notifications	read	List the guest emails sent for a booking (confirmation, rescheduled, cancelled, reminder, no_show, thank_you),…
bookme_resend_notification	write	Send the guest a booking email again.

bookme_create_booking follows the same slot, minimum-notice and capacity rules as the booking page, and performs its provider/Zoom setup and confirmation work. The requested end time must equal the start time plus the calendar duration. Supply guest_phone for phone-call calendars and custom_answers keyed by calendar question ID when answers are required.

InvoiceMe

Tool	Type	Description
invoiceme_list_quotes	read	List quotes (estimates) in the workspace, newest first.
invoiceme_get_quote	read	Get one quote with its line items (lines) and customer.
invoiceme_create_quote	write	Create a DRAFT quote and return its ID and number.
invoiceme_update_quote	write	Edit a DRAFT quote (a sent quote is a document the customer already holds and cannot be edited).
invoiceme_send_quote	write	Send a DRAFT quote to its customer (status draft -> sent; the customer is emailed a link to review and accept).
invoiceme_quote_decision	write	Record the customer's decision on a SENT quote: decision 'accept' (status -> accepted) or 'decline' (status ->…
invoiceme_convert_quote	write	Convert a SENT or ACCEPTED quote into a DRAFT invoice (lines, customer and totals are copied; the quote becomes…
invoiceme_delete_quote	write	Permanently delete a DRAFT quote.
invoiceme_list_service_items	read	List the workspace's service catalog: saved billable items (name, description, unitAmountCents, taxBps) to…
invoiceme_create_service_item	write	Add an item to the service catalog.
invoiceme_update_service_item	write	Update a service catalog item.
invoiceme_delete_service_item	write	Permanently delete a service catalog item (existing invoices and quotes keep their copied lines).
invoiceme_list_invoice_templates	read	List active invoice templates (built-in system templates first, then the workspace's own) with their lines…
invoiceme_create_invoice_template	write	Create an invoice template: a named set of lines (1-50; integer cents; tax_bps basis points) with an optional…
invoiceme_update_invoice_template	write	Update a workspace invoice template.
invoiceme_delete_invoice_template	write	Delete a workspace invoice template (it disappears from the list; invoices made from it are unaffected).
invoiceme_duplicate_invoice_template	write	Copy an invoice template (system or workspace) into a new editable workspace template named '<name> (copy)'.
invoiceme_list_recurring_schedules	read	List recurring invoice schedules (soonest next invoice first): name, customer, frequency, next invoice date,…
invoiceme_create_recurring_schedule	write	Create a recurring invoice schedule that generates a draft invoice for a customer every period starting on…
invoiceme_update_recurring_schedule	write	Update a recurring invoice schedule.
invoiceme_update_settings	write	Update the workspace's invoice settings (see invoiceme_get_settings for current values).
invoiceme_list_reminders	read	List payment reminders that were sent (automatic and manual), newest first: invoice, reminder number, source…
invoiceme_invoices_by_opportunity	read	List the invoices linked to a CRM opportunity (number, status, totalCents, currency, issue date, paid date),…
invoiceme_get_settings	read	Get invoice settings for the workspace (currency, numbering, payment terms, etc.).
invoiceme_list_customers	read	List all invoice customers in the workspace with identity details (name, email).
invoiceme_get_customer	read	Get a single invoice customer by ID with identity details.
invoiceme_list_invoices	read	List invoices in the workspace, newest first.
invoiceme_get_invoice	read	Get a single invoice by ID with full details: the invoice, its line items (lines), the customer and the…
invoiceme_ar_aging	read	Accounts-receivable aging report: outstanding (sent, unpaid) invoices bucketed by days overdue per currency,…
invoiceme_create_draft	write	Create a draft invoice and return its ID and auto-generated number.
invoiceme_set_customer	write	Set (or change) the customer on a DRAFT invoice.
invoiceme_replace_lines	write	Replace ALL line items on a DRAFT invoice (max 50; pass [] to clear).
invoiceme_update_terms	write	Update the issue date, due date and notes of a DRAFT invoice.
invoiceme_delete_draft	write	Permanently delete a DRAFT invoice.
invoiceme_send_reminder	write	Send a manual payment reminder email for a SENT, unpaid invoice.
invoiceme_create_customer	write	Create an invoice customer (finds or creates the underlying contact identity by email).
invoiceme_update_customer	write	Update an invoice customer's default payment terms (days) and/or internal notes (null clears).
invoiceme_send_invoice	write	Send a draft invoice to the customer.
invoiceme_mark_paid	write	Mark a sent invoice as paid.
invoiceme_void_invoice	write	Void an invoice.

Knowledge Base

Tool	Type	Description
knowledge_search_articles	read	Search knowledge base articles within one space by relevance.
knowledge_get_article	read	Get a single knowledge base article by ID or slug with full content.
knowledge_create_article	write	Create a new knowledge base article in the specified space.
knowledge_update_article	write	Update an existing knowledge base article.
knowledge_list_spaces	read	List the knowledge base spaces in this workspace (archived spaces are hidden, same as the app).
knowledge_list_categories	read	List the categories of one knowledge base space with article counts.
knowledge_publish_article	write	Publish a knowledge base article (makes it visible to the space's audience; in a public space that means the…
knowledge_unpublish_article	write	Unpublish a knowledge base article, returning it to draft.
knowledge_list_article_versions	read	List the saved versions of a knowledge base article, newest first (id, version number, title, author, date).
knowledge_restore_article_version	write	Restore an earlier version of a knowledge base article's title and content.
knowledge_upload_image	write	Upload one image into the workspace (fetched from a URL or base64) and return a stable URL + ready-to-paste markup.
knowledge_upload_images	write	Batch upload (≤25) images; each item succeeds or fails independently.
knowledge_create_space	write	Create a knowledge base space.
knowledge_update_space	write	Update a knowledge base space's name, icon, support contact or sort order.
knowledge_archive_space	write	DESTRUCTIVE: archive a knowledge base space.
knowledge_create_category	write	Create a category in a knowledge base space (optionally nested one level under another category of the same space).
knowledge_update_category	write	Update a knowledge base category.
knowledge_move_article	write	Move an article to another knowledge base space of this workspace (its category is dropped, since categories…
knowledge_pin_article	write	Pin or unpin a knowledge base article (pinned articles surface first).
knowledge_delete_article	write	DESTRUCTIVE: permanently delete a knowledge base article with its version history.

Inventory

Tool	Type	Description
inventory_search_items	read	Search inventory items by name, SKU, or description.
inventory_get_item	read	Get a single inventory item by ID with full details including stock levels.
inventory_low_stock	read	List active items whose stock (at locations you can access) is below their reorder point, most depleted first.
inventory_create_item	write	Create a new inventory item.
inventory_update_item	write	Update an inventory item.
inventory_delete_item	write	DESTRUCTIVE: delete an inventory item.
inventory_list_categories	read	List inventory categories (name, parent, item count, total quantity).
inventory_create_category	write	Create an inventory category, optionally nested under parent_id (from inventory_list_categories).
inventory_update_category	write	Rename or re-parent an inventory category.
inventory_delete_category	write	DESTRUCTIVE: permanently delete an inventory category (not recoverable).
inventory_search_transactions	read	Search the stock transaction ledger (receive, ship, transfer, adjust, reserve, release), newest first.
inventory_create_transaction	write	Record a stock transaction for an item at a location: receive (add), ship (remove), adjust (signed correction),…

Suppliers

Tool	Type	Description
suppliers_search	read	Search suppliers by name, code, or contact info (trashed: true lists deleted suppliers).
suppliers_get	read	Get a single supplier by ID with full details including contact person, owner and category name.
suppliers_list_categories	read	List the workspace's supplier categories.
suppliers_create	write	Create a new supplier.
suppliers_update	write	Update a supplier.
suppliers_delete	write	DESTRUCTIVE: move a supplier to the trash and cancel all of its subscriptions.
suppliers_restore	write	Bring a deleted supplier back from the trash, with the subscriptions its delete cancelled.
suppliers_search_subscriptions	read	Search supplier subscriptions/contracts (name, amount, billing cycle, renewal dates).
suppliers_get_subscription	read	Get one supplier subscription by ID (from suppliers_search_subscriptions) with owner, dates and supplier name.
suppliers_create_subscription	write	Create a subscription/contract for a supplier (supplier_id from suppliers_search).
suppliers_update_subscription	write	Update a supplier subscription (id from suppliers_search_subscriptions).
suppliers_delete_subscription	write	DESTRUCTIVE: delete a supplier subscription (id from suppliers_search_subscriptions).
suppliers_create_category	write	Create a supplier category.
suppliers_update_category	write	Update a supplier category (id from suppliers_list_categories).
suppliers_delete_category	write	DESTRUCTIVE: delete a supplier category (id from suppliers_list_categories).

Changelog

Tool	Type	Description
changelog_search_entries	read	Search changelog entries by query, topic, or category.
changelog_list_topics	read	List all changelog topics in the workspace that the caller has been granted access to.
changelog_create_entry	write	Create a new changelog entry in a topic (see changelog_list_topics for topic ids).
changelog_get_entry	read	Get one changelog entry by ID with its full content, status (draft/published) and topic.
changelog_update_entry	write	Edit an existing changelog entry: title, body (markdown), category, version, link.
changelog_publish_entry	write	Publish a DRAFT changelog entry (sets it live and stamps the publish date).
changelog_delete_entry	write	DESTRUCTIVE, cannot be undone: permanently delete a changelog entry (a published entry disappears from the…
changelog_create_topic	write	Create a changelog topic (a named feed of entries).
changelog_update_topic	write	Edit a changelog topic's name, slug, description, website or visibility.
changelog_delete_topic	write	DESTRUCTIVE, cannot be undone: permanently delete a changelog topic together with ALL its entries, subscribers…
changelog_list_subscribers	read	List a topic's email subscribers (email, active/paused, last notified) plus deliverability: on a workspace-only…
changelog_add_subscriber	write	Subscribe an email address to a topic (re-activates it if it was paused).
changelog_update_subscriber	write	Pause (is_active=false) or resume (is_active=true) one subscriber; paused subscribers receive no emails but…
changelog_remove_subscriber	write	DESTRUCTIVE: remove one subscriber from a topic (they can be re-added with changelog_add_subscriber).
changelog_get_settings	read	Get a topic's branding settings (logo URL and accent color hex) used on its public changelog page and widget.
changelog_update_settings	write	Update a topic's branding settings: logo_url (http(s) URL) and accent_color (#RRGGBB hex).

Workflows

Tool	Type	Description
workflow_list	read	List all workflows in the workspace.
workflow_get	read	Get a single workflow by ID with its steps (trigger, conditions, actions).
workflow_list_lookup_options	read	List the ids workflow steps refer to: published forms (trigger formId), booking calendars with their custom…
workflow_create	write	Create a new workflow automation.
workflow_update	write	Edit a workflow's name, description, trigger event, condition operator and/or steps.
workflow_set_enabled	write	Turn a workflow on (is_active=true: it starts reacting to its trigger event) or off.
workflow_activate_form_template	write	Turn on a ready-made automation for a form: template_id 'create_lead' creates a CRM lead from every submission,…
workflow_delete	write	DESTRUCTIVE, cannot be undone: permanently delete a workflow, its steps and its execution history (a ticket…
workflow_duplicate	write	Copy a workflow and all its steps into a new INACTIVE workflow named 'Copy of ...'.
workflow_dry_run	read	Simulate a workflow against sample data WITHOUT executing any action: reports, per step, whether it would pass,…
workflow_list_executions	read	List workflow execution history (newest first).
workflow_retry_execution	write	Re-run a FAILED workflow execution from its first failed action (actions run for real: emails are sent, records…

Polls

Tool	Type	Description
polls_list	read	List all polls in the workspace with summary statistics.
polls_get	read	Get a single poll by ID with its questions and options.
polls_create	write	Create a new poll (always saved as a DRAFT; call polls_publish to open it for voting).
polls_update	write	Update a poll's title, description and settings (anonymous, public, display mode, closing time, website).
polls_replace_draft_content	write	Replace ALL questions and options of a DRAFT poll (the editor's full save); optionally also update title,…
polls_update_question	write	Reword a question and/or toggle whether it is required on a DRAFT or ACTIVE poll (not closed/archived).
polls_update_option	write	Relabel an answer option on a DRAFT or ACTIVE poll (not closed/archived).
polls_add_option	write	Add an answer option to an mcq or multi_select question of a DRAFT or ACTIVE poll (yes_no, rating and text…
polls_remove_option	write	DESTRUCTIVE: remove an answer option from an mcq or multi_select question of a DRAFT or ACTIVE poll.
polls_add_question	write	Add a question to a DRAFT or ACTIVE poll, appended after the existing ones.
polls_remove_question	write	DESTRUCTIVE: remove a question (and its options) from a DRAFT or ACTIVE poll.
polls_reorder_questions	write	Reorder the questions of a DRAFT or ACTIVE poll.
polls_publish	write	Publish a DRAFT poll so it opens for voting (draft -> active).
polls_close	write	Close an ACTIVE poll so it stops accepting votes (active -> closed).
polls_archive	write	Archive a CLOSED poll (closed -> archived).
polls_delete	write	DESTRUCTIVE, cannot be undone: permanently delete a poll with all its questions, options and responses.
polls_vote	write	Cast the caller's own vote on an ACTIVE poll, as a workspace member (one vote per member, cannot be changed).
polls_get_results	read	Get poll results with vote counts and percentages per question/option.
polls_get_responses	read	Get every individual response to a poll (one row per answer) with the question and option labels and, for…

Tags, Comments and Attachments

Generic tools that work on any supported record (see the tool descriptions for the supported entity_type values).

Tool	Type	Description
tags_list	read	List the tags on a record and the tags you can add to it.
tags_add	write	Add a tag to a ticket, Stackr card or CRM opportunity/contact/company.
tags_remove	write	Remove a tag from a ticket, Stackr card or CRM opportunity/contact/company.
comments_list	read	List the comments on a CRM opportunity/contact/company or a Stackr discussion topic (oldest first by default):…
comments_add	write	Add a comment (or a reply) to a CRM opportunity/contact/company or a Stackr discussion topic.
comments_update	write	Edit one of YOUR OWN comments (plain text, 1-10000 characters).
comments_delete	write	Delete one of YOUR OWN comments (and its replies and attachments, like the app).
attachments_list	read	List the files attached to a ticket, ticket message, Stackr card or checklist item, CRM record, supplier,…
attachments_rename	write	Rename an attachment's display file name (the stored file and its downloads are untouched).
attachments_delete	write	Permanently delete an attachment (row and stored file).

Trash

What you deleted, or may restore, across apps: Stackr projects, CRM pipelines, deals, contacts and companies, and suppliers. You see and restore only what you could restore in the app itself, within the apps your token covers. Nothing in the trash is erased.

Tool	Type	Description
trash_list	read	List what is in the trash that you can restore, newest first; each item's id is what trash_restore takes.
trash_restore	write	Bring items back by trash item id; a deal waits for its pipeline (restore both together and it goes first).

Forms

Tool	Type	Description
forms_list	read	List the forms in the workspace with submission statistics.
forms_get	read	Get a single form by ID with its fields, settings, and submission count.