Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/backend/src/adapters/catalog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,7 @@ import * as huggingface from './intl/huggingface.json';
import * as hunter from './intl/hunter.json';
import * as idealista from './intl/idealista.json';
import * as ideasoft from './intl/ideasoft.json';
import * as iiko from './intl/iiko.json';
import * as imapSmtp from './intl/imap-smtp.json';
import * as immich from './intl/immich.json';
import * as incidentIo from './intl/incident-io.json';
Expand Down Expand Up @@ -824,6 +825,7 @@ import * as xxxlutz from './intl/xxxlutz.json';
import * as yandexDirect from './intl/yandex-direct.json';
import * as yandexDisk from './intl/yandex-disk.json';
import * as yandexMetrica from './intl/yandex-metrica.json';
import * as yclients from './intl/yclients.json';
import * as youcom from './intl/youcom.json';
import * as yougile from './intl/yougile.json';
import * as youtrack from './intl/youtrack.json';
Expand Down Expand Up @@ -1667,6 +1669,7 @@ const RAW_ADAPTERS: AdapterDefinition[] = [
hunter as unknown as AdapterDefinition,
idealista as unknown as AdapterDefinition,
ideasoft as unknown as AdapterDefinition,
iiko as unknown as AdapterDefinition,
imapSmtp as unknown as AdapterDefinition,
immich as unknown as AdapterDefinition,
incidentIo as unknown as AdapterDefinition,
Expand Down Expand Up @@ -2098,6 +2101,7 @@ const RAW_ADAPTERS: AdapterDefinition[] = [
yandexDirect as unknown as AdapterDefinition,
yandexDisk as unknown as AdapterDefinition,
yandexMetrica as unknown as AdapterDefinition,
yclients as unknown as AdapterDefinition,
youcom as unknown as AdapterDefinition,
yougile as unknown as AdapterDefinition,
youtrack as unknown as AdapterDefinition,
Expand Down
3 changes: 2 additions & 1 deletion packages/backend/src/adapters/intl/evolution-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
"Evolution WhatsApp"
],
"description": "Let your AI use a WhatsApp number through your own Evolution API server (v2), the self-hosted open-source WhatsApp gateway: read stored chats, messages, contacts and groups, check numbers, and send text, media, voice messages and locations. Unofficial gateway; for Meta's official API use WhatsApp Business Cloud API.",
"instructions": "## Evolution API\nThis connector talks to an **Evolution API** server (version 2), an open-source WhatsApp gateway that you host yourself. One connector works with one **instance**, that is one linked WhatsApp number: connection state, chats, messages and contacts the server has stored, groups, number checks, and sending text, media, audio and locations.\n\n**Unofficial gateway, read this first.** Evolution API is not a Meta product. With its default Baileys integration it drives a normal WhatsApp or WhatsApp Business account that you link by QR code, the way WhatsApp Web does. WhatsApp does not support this and can limit or ban numbers that send automated or unsolicited messages. The official route is the **WhatsApp Business Cloud API** connector in this catalog (Meta's API, with approved templates). Use this connector only with a number you own, for conversations people expect, and at a human pace.\n\n**Setup (about 10 minutes, you run the server)**\n1. Install Evolution API v2 following https://doc.evolution-api.com/v2 (Docker with PostgreSQL and Redis). On AnythingMCP Cloud the server must be reachable from the internet over HTTPS.\n2. In its manager (`/manager`) create an instance and link the phone by scanning the QR code (WhatsApp, Linked devices). The instance must show **open**.\n3. Fill in `EVOLUTION_API_URL` (the server address) and `EVOLUTION_INSTANCE` (the instance name, exactly as in the manager).\n4. Fill in `EVOLUTION_API_KEY`. Prefer the **token of the instance** (shown on the instance in the manager): it only reaches that instance. The global key (`AUTHENTICATION_API_KEY` in the server's environment) reaches every instance and can create and delete them. The key is sent in the `apikey` header.\n\n**Where to start**: `evolution_api_get_connection_state` must answer `open`. `evolution_api_list_instances` shows the linked number, `evolution_api_get_server_info` the server version. Then `evolution_api_find_chats` for the latest conversations and `evolution_api_find_messages` for one of them.\n\n**Reading**: `evolution_api_find_chats`, `evolution_api_find_messages`, `evolution_api_find_contacts`, `evolution_api_fetch_profile`, `evolution_api_check_whatsapp_numbers`, `evolution_api_list_groups`, `evolution_api_get_group`, `evolution_api_list_group_participants`, `evolution_api_get_settings` and `evolution_api_get_webhook`. The find tools are POST requests that only read.\n\n**Writing**: `evolution_api_send_text`, `evolution_api_send_media` (image, video or document by URL), `evolution_api_send_audio` (voice message by URL), `evolution_api_send_location`, `evolution_api_send_reaction`, `evolution_api_update_message`, `evolution_api_delete_message` (switched off at install), `evolution_api_mark_messages_read` and `evolution_api_send_presence` (typing). Every send leaves at once from the linked phone number: confirm the recipient and the content with the user.\n\n**Field notes**\n- Recipients: pass `number` as digits with country code (5511999998888) or as a WhatsApp id. Ids (`remoteJid`) end in `@s.whatsapp.net` for a person and `@g.us` for a group; WhatsApp also uses `@lid` ids that hide the phone number. Pass ids back exactly as received.\n- Unknown numbers: call `evolution_api_check_whatsapp_numbers` and write to the `jid` it returns. A send to a number that is not on WhatsApp answers 400 with `exists: false`.\n- A message is identified by its key: `remoteJid`, `fromMe` and `id`. Reactions, edits, deletes and read receipts need all three.\n- Message text is in `message.conversation` or `message.extendedTextMessage.text`. `messageTimestamp` is Unix seconds.\n- Chats, messages and contacts come from the server's own database: what it stored since the instance was linked. With the settings `groupsIgnore` or without `syncFullHistory`, group chats or older history are missing. Check them with the settings tool.\n- The state `connecting` or `close` means the phone must be linked again in the manager; this connector does not show QR codes and does not create, restart, log out or delete instances.\n- Pace: wait a few seconds between messages (`delay` shows typing first) and do not write to people who never contacted the number; that is what gets numbers banned.",
"instructions": "> **Status (Nov 2026): taken out of the store.** This connector drives WhatsApp through an unofficial, self-hosted gateway. WhatsApp's terms do not allow unofficial clients and can lead to a banned number, so it is no longer offered in the catalog. Use the official **WhatsApp Business Cloud API** connector (`whatsapp-business`) instead. The adapter is kept and still resolvable by slug, so connectors installed earlier keep working.\n\n## Evolution API\nThis connector talks to an **Evolution API** server (version 2), an open-source WhatsApp gateway that you host yourself. One connector works with one **instance**, that is one linked WhatsApp number: connection state, chats, messages and contacts the server has stored, groups, number checks, and sending text, media, audio and locations.\n\n**Unofficial gateway, read this first.** Evolution API is not a Meta product. With its default Baileys integration it drives a normal WhatsApp or WhatsApp Business account that you link by QR code, the way WhatsApp Web does. WhatsApp does not support this and can limit or ban numbers that send automated or unsolicited messages. The official route is the **WhatsApp Business Cloud API** connector in this catalog (Meta's API, with approved templates). Use this connector only with a number you own, for conversations people expect, and at a human pace.\n\n**Setup (about 10 minutes, you run the server)**\n1. Install Evolution API v2 following https://doc.evolution-api.com/v2 (Docker with PostgreSQL and Redis). On AnythingMCP Cloud the server must be reachable from the internet over HTTPS.\n2. In its manager (`/manager`) create an instance and link the phone by scanning the QR code (WhatsApp, Linked devices). The instance must show **open**.\n3. Fill in `EVOLUTION_API_URL` (the server address) and `EVOLUTION_INSTANCE` (the instance name, exactly as in the manager).\n4. Fill in `EVOLUTION_API_KEY`. Prefer the **token of the instance** (shown on the instance in the manager): it only reaches that instance. The global key (`AUTHENTICATION_API_KEY` in the server's environment) reaches every instance and can create and delete them. The key is sent in the `apikey` header.\n\n**Where to start**: `evolution_api_get_connection_state` must answer `open`. `evolution_api_list_instances` shows the linked number, `evolution_api_get_server_info` the server version. Then `evolution_api_find_chats` for the latest conversations and `evolution_api_find_messages` for one of them.\n\n**Reading**: `evolution_api_find_chats`, `evolution_api_find_messages`, `evolution_api_find_contacts`, `evolution_api_fetch_profile`, `evolution_api_check_whatsapp_numbers`, `evolution_api_list_groups`, `evolution_api_get_group`, `evolution_api_list_group_participants`, `evolution_api_get_settings` and `evolution_api_get_webhook`. The find tools are POST requests that only read.\n\n**Writing**: `evolution_api_send_text`, `evolution_api_send_media` (image, video or document by URL), `evolution_api_send_audio` (voice message by URL), `evolution_api_send_location`, `evolution_api_send_reaction`, `evolution_api_update_message`, `evolution_api_delete_message` (switched off at install), `evolution_api_mark_messages_read` and `evolution_api_send_presence` (typing). Every send leaves at once from the linked phone number: confirm the recipient and the content with the user.\n\n**Field notes**\n- Recipients: pass `number` as digits with country code (5511999998888) or as a WhatsApp id. Ids (`remoteJid`) end in `@s.whatsapp.net` for a person and `@g.us` for a group; WhatsApp also uses `@lid` ids that hide the phone number. Pass ids back exactly as received.\n- Unknown numbers: call `evolution_api_check_whatsapp_numbers` and write to the `jid` it returns. A send to a number that is not on WhatsApp answers 400 with `exists: false`.\n- A message is identified by its key: `remoteJid`, `fromMe` and `id`. Reactions, edits, deletes and read receipts need all three.\n- Message text is in `message.conversation` or `message.extendedTextMessage.text`. `messageTimestamp` is Unix seconds.\n- Chats, messages and contacts come from the server's own database: what it stored since the instance was linked. With the settings `groupsIgnore` or without `syncFullHistory`, group chats or older history are missing. Check them with the settings tool.\n- The state `connecting` or `close` means the phone must be linked again in the manager; this connector does not show QR codes and does not create, restart, log out or delete instances.\n- Pace: wait a few seconds between messages (`delay` shows typing first) and do not write to people who never contacted the number; that is what gets numbers banned.",
"region": "intl",
"category": "messaging",
"icon": "evolution-api",
"docsUrl": "https://doc.evolution-api.com/v2/api-reference/get-information",
"unlisted": true,
"prerequisites": "Your own Evolution API v2 server (self-hosted), reachable from AnythingMCP (on Cloud: public over HTTPS), with an instance linked to a WhatsApp number by QR code, and that instance's token or the global API key. Evolution API is an unofficial gateway; the official route is the WhatsApp Business Cloud API connector.",
"requiredEnvVars": [
"EVOLUTION_API_URL",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,12 @@ describe('evolution-api adapter: static contract', () => {
for (const entry of perInstance) expect(entry.endpointMapping.path.endsWith('/{{EVOLUTION_INSTANCE}}')).toBe(true);
});

it('is unlisted and points to the official WhatsApp connector', () => {
expect((a as { unlisted?: boolean }).unlisted).toBe(true);
expect(a.instructions).toMatch(/taken out of the store/);
expect(a.instructions).toMatch(/whatsapp-business/);
});

it('says it is an unofficial gateway and names the official connector', () => {
expect(a.instructions).toMatch(/Unofficial gateway/);
expect(a.instructions).toContain('WhatsApp Business Cloud API');
Expand Down
Loading
Loading