TOOLS.md

Tools

100 tools in 13 toolsets. The local server registers all of them; the hosted server registers 92 (the local-only tools are left out). Which of them a connection sees also depends on its enabled toolsets, its policy and the integration of its instance; see the README.

Columns: Kind is read, write, destructive (sends to other people, or replaces or removes something) or irreversible (cannot be undone from this server). Integrations are the Evolution integrations the tool works on: Baileys is WHATSAPP-BAILEYS, Business is WHATSAPP-BUSINESS, Evolution is EVOLUTION. Local only tools are not offered by the hosted server.

instance

Connection status, QR pairing, restart, logout and online presence of the instance. 5 tools.

Tool	Title	Kind	Integrations	Local only	What it does
get_instance_status	Get instance status	read	all	no	Report the connection state, integration and enabled toolsets of this Evolution instance.
logout_instance	Log out WhatsApp session	irreversible	Baileys	no	Unlink the WhatsApp session from this instance so that it stops receiving and sending messages.
restart_instance	Restart instance connection	destructive	Baileys	no	Restart the WhatsApp connection of this instance and return the connection state afterwards.
set_presence	Set online presence	write	Baileys	no	Show this WhatsApp number as online or offline to its contacts.
start_pairing	Start device pairing	write	Baileys	no	Start linking this WhatsApp Web instance to a phone and return a QR code or a pairing code.

messaging (default)

Send text, media, voice notes, locations, contact cards, polls, list and button messages; react, edit and delete sent messages. 16 tools.

Tool	Title	Kind	Integrations	Local only	What it does
delete_message_for_everyone	Delete message for everyone	irreversible	Baileys	no	Delete a message this number sent from the chat for every participant (WhatsApp Web instances only).
edit_message	Edit sent message	destructive	Baileys	no	Replace the text of a message this number sent, or the caption of its image or video.
forward_message	Forward message	destructive	Baileys, Business	no	Forward a stored message to 1 to 5 chats by sending its text, media, location or contact again.
react_to_message	React to message	destructive	Baileys, Business	no	React to a message with an emoji, or remove the reaction with an empty emoji.
send_button_message	Send button message	destructive	all	no	Send a message with up to three buttons: quick replies, links, call buttons or copy-code buttons.
send_chat_presence	Show typing or recording	write	Baileys	no	Show a typing or recording indicator in a chat for a few seconds (WhatsApp Web instances only).
send_contact_card	Send contact card	destructive	Baileys, Business	no	Send one or more contact cards (name and phone number) to a person or group.
send_list_message	Send list message	destructive	Baileys, Business	no	Send a message with a button that opens a list of selectable rows.
send_local_files	Send local files	destructive	all	yes	Send 1 to 10 files from this computer to a person or group, one message per file.
send_location	Send location	destructive	Baileys, Business	no	Send a map location pin with a name and address.
send_media_message	Send media from URL	destructive	all	no	Send an image, video, audio file or document that Evolution downloads from a public URL.
send_poll	Send poll	destructive	Baileys	no	Send a poll to a person or group (WhatsApp Web instances only).
send_sticker	Send sticker	destructive	Baileys	no	Send a sticker from a public image URL (WhatsApp Web instances only).
send_text_message	Send text message	destructive	all	no	Send a text message to a person or group from the connected number.
send_video_note	Send video note	destructive	Baileys	no	Send a video from a public URL as a round video note (WhatsApp Web instances only).
send_voice_note	Send voice note	destructive	all	no	Send an audio file from a public URL as a voice message.

chats (default)

List chats, show the newest messages across chats, read and search message history, delivery status, read/unread and archive state, received media. 13 tools.

Tool	Title	Kind	Integrations	Local only	What it does
download_message_media	Download message media	write	Baileys, Business	no	Save the attachment of a message (image, video, voice note, audio, document or sticker) as a file.
export_chat	Export chat	write	Baileys, Business	no	Save a chat, or one period of it, as a transcript with its attachments.
get_chat	Get chat details	read	all	no	Describe one chat or person: name, phone number, unread count, labels, groups in common and the last message.
get_message	Get message	read	all	no	Return one stored message in full, including its raw Evolution message type and its reactions.
get_message_status	Get message delivery status	read	all	no	Report how far a message got: sent, delivered, read or played.
list_chats	List chats	read	all	no	List chats with unread counts and a preview of the latest message, most recently active first.
list_recent_messages	List recent messages	read	all	no	Show the newest messages of every chat in one call, grouped by chat, for a period.
mark_chat_read	Mark chat as read	destructive	Baileys	no	Mark received messages of a chat as read, so their senders see blue ticks.
mark_chat_unread	Mark chat as unread	write	Baileys	no	Mark a chat as unread on the linked phone, so it shows the unread dot again.
read_messages	Read chat messages	read	all	no	Read the stored message history of one chat, newest first, page by page.
search_messages	Search messages	read	all	no	Find messages by words, sender, message type or document name, newest first, across chats or in one chat.
set_chat_archived	Archive or unarchive chat	write	Baileys	no	Archive a chat or move it back to the main chat list.
view_message_image	View image message	read	Baileys, Business	no	Show the image or sticker of a received or sent message as an image.

contacts (default)

Find chats by name or number, check numbers on WhatsApp, profiles and profile pictures, block and unblock. 6 tools.

Tool	Title	Kind	Integrations	Local only	What it does
block_contact	Block contact	destructive	Baileys	no	Block a person on WhatsApp.
check_whatsapp_numbers	Check numbers on WhatsApp	read	Baileys	no	Check which phone numbers have a WhatsApp account.
find_chats	Find chats by name or number	read	all	no	Turn a name or phone number into chat_ids: people and groups whose name or number matches the query.
get_business_profile	Get business profile	read	Baileys	no	Get the WhatsApp Business profile of a person or company.
get_contact_profile	Get contact profile	read	Baileys	no	Get the public WhatsApp profile of one person: name, about text, picture and business details.
unblock_contact	Unblock contact	write	Baileys	no	Unblock a person on WhatsApp.

groups

Group details, participants, invite links, creation, settings and membership. 17 tools.

Tool	Title	Kind	Integrations	Local only	What it does
add_group_participants	Add group participants	destructive	Baileys	no	Add people to a group.
create_group	Create group	destructive	Baileys	no	Create a new group with the given participants.
get_group	Get group details	read	Baileys	no	Get one group's subject, description, settings and participants.
get_group_invite_link	Get group invite link	read	Baileys	no	Get the current invite link of a group.
get_invite_info	Preview group invite	read	Baileys	no	Preview a group from its invite link or code without joining it.
join_group_by_invite	Join group by invite	destructive	Baileys	no	Join a group through its invite link or code.
leave_group	Leave group	irreversible	Baileys	no	Leave a group.
list_groups	List groups	read	Baileys	no	List the groups this number belongs to, sorted by subject.
remove_group_participants	Remove group participants	destructive	Baileys	no	Remove people from a group.
revoke_group_invite_link	Reset group invite link	destructive	Baileys	no	Reset a group's invite link so the old link stops working.
send_group_invite	Send group invite	destructive	Baileys	no	Send a group's invite link to people in private chats.
set_disappearing_messages	Set disappearing messages	destructive	Baileys	no	Turn disappearing messages on or off for a group.
update_group_admins	Promote or demote group admins	destructive	Baileys	no	Promote participants to group admin or demote admins to regular participants.
update_group_description	Update group description	destructive	Baileys	no	Replace a group's description.
update_group_picture	Update group picture	destructive	Baileys	no	Replace a group's picture with an image downloaded from a URL.
update_group_settings	Update group settings	destructive	Baileys	no	Change who may send messages in a group and who may edit its info.
update_group_subject	Rename group	destructive	Baileys	no	Rename a group.

labels

WhatsApp Business app labels on chats. 3 tools.

Tool	Title	Kind	Integrations	Local only	What it does
add_chat_label	Add label to chat	write	Baileys	no	Attach a label to the chat with one person.
list_labels	List labels	read	Baileys	no	List the labels defined on this WhatsApp account.
remove_chat_label	Remove label from chat	write	Baileys	no	Detach a label from the chat with one person.

profile

The instance's own profile name, about text, picture and privacy settings. 7 tools.

Tool	Title	Kind	Integrations	Local only	What it does
get_my_profile	Get own profile	read	Baileys	no	Get the WhatsApp profile of the number this instance is linked to.
get_privacy_settings	Get privacy settings	read	Baileys	no	Get who can see this account's read receipts, profile photo, about text, online status and last seen.
remove_profile_picture	Remove profile picture	destructive	Baileys	no	Remove the profile picture of this WhatsApp account.
update_privacy_settings	Update privacy settings	destructive	Baileys	no	Change who can see this account's read receipts, profile photo, about text, last seen and online status.
update_profile_about	Update profile about text	destructive	Baileys	no	Change the about text (the short status line) of this account's WhatsApp profile.
update_profile_name	Update profile name	destructive	Baileys	no	Change the WhatsApp display name (push name) of this account.
update_profile_picture	Update profile picture	destructive	Baileys	no	Change the profile picture of this WhatsApp account to the image at a URL.

status

Post status updates. 1 tools.

Tool	Title	Kind	Integrations	Local only	What it does
post_status	Post status update	destructive	Baileys	no	Post a status update (a story that disappears after 24 hours) from this WhatsApp number.

catalog

WhatsApp Business app product catalog and collections. 2 tools.

Tool	Title	Kind	Integrations	Local only	What it does
list_catalog_collections	List catalog collections	read	Baileys	no	List the product collections (named groups of products) of a WhatsApp Business catalog.
list_catalog_products	List catalog products	read	Baileys	no	List the products in the WhatsApp Business catalog of this account or of another business.

templates

WhatsApp Business Platform message templates: list, create, edit, delete and send. 5 tools.

Tool	Title	Kind	Integrations	Local only	What it does
create_template	Create message template	write	Business	no	Submit a new message template to Meta for review on this WhatsApp Business Platform instance.
delete_template	Delete message template	irreversible	Business	no	Delete a message template from this WhatsApp Business Platform instance.
edit_template	Edit message template	destructive	Business	no	Change the components or category of an existing message template on this WhatsApp Business Platform instance.
list_templates	List message templates	read	Business	no	List the message templates of this WhatsApp Business Platform instance with their approval status.
send_template_message	Send template message	destructive	Business	no	Send an approved message template to a phone number through the WhatsApp Business Platform.

settings

Instance behaviour settings and proxy. 4 tools.

Tool	Title	Kind	Integrations	Local only	What it does
get_instance_settings	Get instance settings	read	all	no	Read the behaviour settings of this Evolution instance.
get_proxy	Get proxy settings	read	all	no	Read the proxy this Evolution instance uses to reach WhatsApp.
set_proxy	Set proxy	destructive	all	yes	Enable, replace or disable the proxy this Evolution instance uses to reach WhatsApp.
update_instance_settings	Update instance settings	destructive	all	no	Change behaviour settings of this Evolution instance; settings not given keep their current value.

events

Webhook and event-stream (WebSocket, RabbitMQ, NATS, SQS, Kafka, Pusher) configuration. 4 tools.

Tool	Title	Kind	Integrations	Local only	What it does
get_event_channel	Get event channel	read	all	no	Read the configuration of one event stream of this Evolution instance.
get_webhook	Get webhook	read	all	no	Read the webhook this Evolution instance calls when WhatsApp events happen.
set_event_channel	Set event channel	destructive	all	yes	Set one event stream (websocket, rabbitmq, nats, sqs, kafka or pusher) of this Evolution instance.
set_webhook	Set webhook	destructive	all	yes	Set the webhook this Evolution instance calls when WhatsApp events happen, replacing the stored one.

integrations

Evolution chatbots (Evolution Bot, Typebot, OpenAI, Dify, Flowise, n8n, EvoAI), their sessions, and Chatwoot. 17 tools.

Tool	Title	Kind	Integrations	Local only	What it does
change_chatbot_session	Change chatbot session	destructive	all	no	Resume, pause, close or delete the chatbot sessions of one chat for an integration.
create_chatbot	Create chatbot	destructive	all	yes	Create a chatbot that answers incoming WhatsApp messages through Evolution Bot, Typebot, OpenAI, Dify, etc.
create_openai_credential	Add OpenAI credential	write	all	yes	Store an OpenAI API key on this Evolution instance so that OpenAI chatbots can use it.
delete_chatbot	Delete chatbot	irreversible	all	no	Delete a chatbot together with all of its sessions; this cannot be undone from this server.
delete_openai_credential	Delete OpenAI credential	irreversible	all	no	Delete a stored OpenAI credential; the key cannot be recovered from this server.
get_chatbot	Get chatbot	read	all	no	Return the full configuration of one chatbot: trigger, behaviour, endpoint and provider-specific fields.
get_chatbot_settings	Get chatbot defaults	read	all	no	Return the session defaults shared by all chatbots of one integration.
get_chatwoot_config	Get Chatwoot integration	read	all	no	Return the Chatwoot integration settings of this instance: account, inbox, sync options and webhook URL.
list_chatbot_sessions	List chatbot sessions	read	all	no	List the conversations a chatbot is currently handling, optionally only those of one chat.
list_chatbots	List chatbots	read	all	no	List the chatbots configured on this Evolution instance, across all integrations or one.
list_openai_credentials	List OpenAI credentials	read	all	no	List the OpenAI credentials stored on this Evolution instance by name and id.
list_openai_models	List OpenAI models	read	all	no	List the OpenAI model ids that a stored credential can use, sorted alphabetically.
set_chatbot_ignored_chat	Ignore chat for chatbot	destructive	all	no	Add a chat to, or remove it from, the list of chats the chatbots of one integration skip.
set_chatwoot_config	Set Chatwoot integration	destructive	all	yes	Save the Chatwoot integration: connect this WhatsApp number to a Chatwoot account and inbox.
start_typebot_session	Start Typebot session	destructive	all	no	Start a Typebot flow in one chat, which sends that person the flow's first messages.
update_chatbot	Update chatbot	destructive	all	yes	Change fields of an existing chatbot; every field left out keeps its stored value, secrets included.
update_chatbot_settings	Update chatbot defaults	destructive	all	no	Change the session defaults shared by all chatbots of one integration; at least one value is required.

Hosted surface for WhatsApp Business Platform instances

A hosted connection to a WHATSAPP-BUSINESS instance with the standard policy and every toolset enabled can call 41 tools. This is the surface the directory listings describe.

• get_instance_status
• forward_message
• react_to_message
• send_button_message
• send_contact_card
• send_list_message
• send_location
• send_media_message
• send_text_message
• send_voice_note
• download_message_media
• export_chat
• get_chat
• get_message
• get_message_status
• list_chats
• list_recent_messages
• read_messages
• search_messages
• view_message_image
• find_chats
• create_template
• edit_template
• list_templates
• send_template_message
• get_instance_settings
• get_proxy
• update_instance_settings
• get_event_channel
• get_webhook
• change_chatbot_session
• get_chatbot
• get_chatbot_settings
• get_chatwoot_config
• list_chatbot_sessions
• list_chatbots
• list_openai_credentials
• list_openai_models
• set_chatbot_ignored_chat
• start_typebot_session
• update_chatbot_settings