wwebjs-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| LOG_LEVEL | No | Log level: debug, info, warn, error | info |
| MCP_HTTP_HOST | No | HTTP bind address | 0.0.0.0 |
| MCP_HTTP_PORT | No | HTTP port | 8080 |
| MCP_TRANSPORT | No | Transport type: http or stdio | stdio |
| MCP_AUTH_TOKEN | No | Optional bearer token for MCP clients | |
| WWEBJS_API_KEY | Yes | API key sent as x-api-key on every request | |
| WWEBJS_API_URL | No | Base URL of the wwebjs-api server | http://localhost:3000 |
| MCP_TOOL_DENYLIST | No | Comma-separated list of tools to hide | |
| WWEBJS_TIMEOUT_MS | No | Per-request timeout in milliseconds | 60000 |
| MCP_TOOL_ALLOWLIST | No | Comma-separated list of tools to expose | |
| CLOUDFLARE_TUNNEL_TOKEN | No | Token for the optional cloudflared service |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| pingA | [Various] Health check. Responds to request with "pong" message |
| localCallbackExampleA | [Various] Local callback. Used to generate a QR code and writes a log file. ONLY FOR DEVELOPMENT/TEST PURPOSES. |
| session_getSessionsC | [Session] Get all sessions. Get all sessions. |
| session_startC | [Session] Start new session. Starts a session for the given session ID. |
| session_stopC | [Session] Stop session. Stops a session for the given session ID. |
| session_statusB | [Session] Get session status. Status of the session with the given session ID. |
| session_qrC | [Session] Get session QR code. QR code of the session with the given session ID. |
| session_qr_imageB | [Session] Get session QR code as image. QR code as image of the session with the given session ID. |
| session_requestPairingCodeC | [Session] Request authentication via pairing code |
| session_restartC | [Session] Restart session. Restarts the session with the given session ID. |
| session_terminateB | [Session] Terminate session. Terminates the session with the given session ID. |
| session_terminateInactiveB | [Session] Terminate inactive sessions. Terminates all inactive sessions. |
| session_terminateAllC | [Session] Terminate all sessions. Terminates all sessions. |
| session_getPageScreenshotC | [Session] Get page screenshot. Screenshot of the client with the given session ID. |
| client_getClassInfoC | [Client] Get current connection information |
| client_acceptInviteB | [Client] Accept an invitation to join a group |
| client_archiveChatC | [Client] Archive the chat |
| client_createGroupC | [Client] Create a new group |
| client_getBlockedContactsA | [Client] Get all blocked contacts by host account |
| client_getChatByIdD | [Client] Get the chat |
| client_getChatLabelsC | [Client] Get all labels assigned to the chat |
| client_getChatsB | [Client] Get all current chats. Retrieve all chats for the given session ID. |
| post_client_getChatsB | [Client] Get all current chats with optional search parameters. Retrieve all chats for the given session ID with optional search parameters. |
| client_getChatsByLabelIdA | [Client] Get all chats for a specific label |
| client_getCommonGroupsB | [Client] Get the contact's common groups. Get the contact's common groups with you. Returns empty array if you don't have any common group. |
| client_getContactByIdD | [Client] Get the contact |
| client_getContactsB | [Client] Get all current contacts |
| client_getInviteInfoC | [Client] Return invite information. Return an object with information about the invite code |
| client_getLabelByIdC | [Client] Get the label |
| client_getLabelsB | [Client] Get all current labels |
| client_addOrRemoveLabelsC | [Client] Change labels in chats |
| client_getNumberIdA | [Client] Get the registered WhatsApp ID for a number. Return null if the number is not registered on WhatsApp |
| client_isRegisteredUserB | [Client] Check if a given ID is registered in WhatsApp |
| client_getProfilePicUrlB | [Client] Return the contact ID's profile picture URL |
| client_getStateC | [Client] Get the current connection state for the client |
| client_markChatUnreadC | [Client] Mark the chat as unread |
| client_muteChatA | [Client] Mute the chat. Mute this chat forever, unless a date is specified |
| client_pinChatB | [Client] Pin the chat |
| client_searchMessagesC | [Client] Search for messages |
| client_sendMessageC | [Client] Send a message to a specific chatId |
| client_sendPresenceAvailableA | [Client] Mark the client as online |
| client_sendPresenceUnavailableB | [Client] Mark the client as unavailable |
| client_sendSeenC | [Client] Mark the chat as seen |
| client_setDisplayNameD | [Client] Set the current user. This is the name shown to WhatsApp users that have not added you as a contact beside your number in groups and in your profile. |
| client_setProfilePictureA | [Client] Set the current user's profile picture |
| client_setStatusB | [Client] Set the current user's status message |
| client_unarchiveChatC | [Client] Changes archive state of the chat |
| client_unmuteChatB | [Client] Unmute the chat |
| client_unpinChatC | [Client] Unpin the chat |
| client_getWWebVersionA | [Client] Return the version of WhatsApp Web currently being run |
| client_deleteProfilePictureB | [Client] Delete the current user's profile picture |
| client_setAutoDownloadAudioC | [Client] Set auto load download audio flag |
| client_setAutoDownloadDocumentsC | [Client] Set auto load download documents flag |
| client_setAutoDownloadPhotosC | [Client] Set auto load download photos flag |
| client_setAutoDownloadVideosB | [Client] Set auto load download videos flag |
| client_syncHistoryD | [Client] Sync chat history |
| client_getContactDeviceCountA | [Client] Get user device count. Each WaWeb Connection counts as one device, and the phone (if exists) counts as one device. So for a non-enterprise user with one WaWeb connection it should return "2" |
| client_getCountryCodeC | [Client] Get the country code |
| client_getFormattedNumberC | [Client] Get the formatted number |
| client_openChatWindowC | [Client] Open the chat window |
| client_openChatWindowAtB | [Client] Open the chat window to the position of the message |
| client_resetStateB | [Client] Force reset of connection state for the client |
| client_setBackgroundSyncA | [Client] Change the background synchronization setting. NOTE: This action will take effect after you restart the client |
| client_getContactLidAndPhoneB | [Client] Get contact lid and phone. Retrieve the contact lid and phone number for a specific chat |
| client_getChannelByInviteCodeC | [Client] Get channel by invite code |
| client_getChannelsC | [Client] Get channels from the client. Retrieve a list of channels from the client |
| client_createChannelB | [Client] Create a new channel |
| client_subscribeToChannelC | [Client] Subscribe to a channel |
| client_unsubscribeFromChannelC | [Client] Unsubscribe from channel |
| client_searchChannelsC | [Client] Search channels |
| client_runMethodC | [Client] Execute a method on the client. Execute a method on the client and return the result |
| chat_getClassInfoD | [Chat] Get the chat |
| chat_clearMessagesB | [Chat] Clear all messages from the chat |
| chat_clearStateA | [Chat] Stop typing or recording in chat immediately |
| chat_deleteC | [Chat] Delete the chat |
| chat_fetchMessagesC | [Chat] Load chat messages. Messages sorted from earliest to latest |
| chat_getContactC | [Chat] Get the contact |
| chat_sendStateRecordingA | [Chat] Simulate recording audio. Simulate recording audio in chat. This will last for 25 seconds |
| chat_sendStateTypingC | [Chat] Simulate typing in chat. Simulate typing in chat. This will last for 25 seconds. |
| chat_sendSeenC | [Chat] Set the message as seen |
| chat_markUnreadC | [Chat] Mark this chat as unread |
| chat_syncHistoryC | [Chat] Sync chat history |
| chat_getLabelsA | [Chat] Return all labels. Return array of all labels assigned to this chat |
| chat_changeLabelsC | [Chat] Add or remove labels |
| chat_runMethodC | [Chat] Execute a method on the chat. Execute a method on the chat and return the result |
| groupChat_getClassInfoC | [Group Chat] Get the group |
| groupChat_addParticipantsB | [Group Chat] Add the participants. Add a list of participants by ID to the group |
| groupChat_demoteParticipantsB | [Group Chat] Demote the participants. Demote participants by ID to regular users |
| groupChat_getInviteCodeC | [Group Chat] Get the invite code. Get the invite code for a specific group |
| groupChat_leaveB | [Group Chat] Leave the group |
| groupChat_promoteParticipantsB | [Group Chat] Promote the participants. Promote participants by ID to admins |
| groupChat_removeParticipantsC | [Group Chat] Remove the participants. Remove a list of participants by ID to the group |
| groupChat_revokeInviteA | [Group Chat] Invalidate the invite code. Invalidate the current group invite code and generates a new one |
| groupChat_setDescriptionB | [Group Chat] Update the group description |
| groupChat_setInfoAdminsOnlyC | [Group Chat] Update the info group settings |
| groupChat_setMessagesAdminsOnlyC | [Group Chat] Update the message group settings |
| groupChat_setSubjectC | [Group Chat] Update the group subject |
| groupChat_setPictureB | [Group Chat] Set the group picture |
| groupChat_deletePictureB | [Group Chat] Delete the group picture |
| groupChat_getGroupMembershipRequestsB | [Group Chat] Get the membership requests |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/victor-halla/wwebjs-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server