You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/green-api/green-api-mcp-gateway/tags)
MCP gateway for GREEN-API WhatsApp. Lets AI agents (Claude Desktop, OpenClaw, Cursor, and others) send messages, manage instances, and receive notifications via WhatsApp using the [Model Context Protocol](https://modelcontextprotocol.io).
24
26
25
27
## What it does
26
28
27
29
Send text messages, files by URL, locations, contacts, polls. Forward and edit messages. Manage groups (create, fetch data, add/remove participants). Check phone numbers for WhatsApp, fetch contacts and their info. Get instance state and settings, QR code for authorization. Receive incoming notifications via polling or an HTTP receiver. Partner API for creating/deleting instances. Multi-instance support in a single gateway. Prompt templates for common scenarios (customer support, broadcasts). Prometheus metrics and OpenTelemetry.
28
30
31
+
Instructions for connecting the MCP server can be found on [our website](https://green-api.com/en/docs/integration/mcp/integration-setup/)
32
+
29
33
## Architecture
30
34
31
35
Clean Architecture (Ports & Adapters):
@@ -184,6 +188,8 @@ docker run --rm -i \
184
188
185
189
### Messaging
186
190
191
+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#sending-messages)
192
+
187
193
- `whatsapp_send_message`— text message
188
194
- `whatsapp_send_file`— file by URL
189
195
- `whatsapp_send_location`— location
@@ -195,6 +201,8 @@ docker run --rm -i \
195
201
196
202
### Instance
197
203
204
+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#instance-management)
205
+
198
206
- `whatsapp_get_state`— authorization state
199
207
- `whatsapp_get_settings`— current settings
200
208
- `whatsapp_set_settings`— update settings
@@ -204,12 +212,16 @@ docker run --rm -i \
204
212
205
213
### Contacts
206
214
215
+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#contacts)
216
+
207
217
- `whatsapp_get_contacts`— contact list
208
218
- `whatsapp_get_contact_info`— contact information
209
219
- `whatsapp_check_whatsapp`— phone number check
210
220
211
221
### Groups
212
222
223
+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#groups)
224
+
213
225
- `whatsapp_create_group`— create a group
214
226
- `whatsapp_get_group_data`— group data
215
227
- `whatsapp_add_group_participant`— add a participant
@@ -218,10 +230,14 @@ docker run --rm -i \
218
230
219
231
### Notifications
220
232
233
+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#notification-queue)
234
+
221
235
- `whatsapp_receive_notification`— receive an incoming notification (long-poll)
222
236
223
237
### Partner API
224
238
239
+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#partner-api)
MCP-шлюз для GREEN-API WhatsApp. Позволяет агентам ИИ (Claude Desktop, OpenClaw, Cursor и другие) отправлять сообщения, управлять инстансами и получать уведомления через WhatsApp, используя [Model Context Protocol](https://modelcontextprotocol.io).
22
24
23
25
## Функциональные возможности
24
26
25
27
Отправка текстовых сообщений, файлов по URL, геолокаций, контактов и опросов. Пересылка и редактирование сообщений. Создание групп, получение данных о группах, добавление и удаление участников. Проверка номеров телефонов на наличие WhatsApp, получение списка контактов и информации о них. Получение статуса и настроек инстанса, генерация QR-кода для авторизации. Получение входящих уведомлений через метод длинных опросов (polling) или HTTP-вебхуки (receiver). Создание и удаление инстансов. Поддержка работы с несколькими инстансами в рамках одного шлюза. Готовые шаблоны для распространенных сценариев (клиентская поддержка, рассылки). Метрики Prometheus и интеграция с OpenTelemetry.
26
28
29
+
С инструкцией по подключению MCP сервера можно ознакомиться [на нашем сайте](https://green-api.com/docs/integration/mcp/integration-setup/)
30
+
27
31
## Архитектура
28
32
29
33
Чистая Архитектура (Порты и Адаптеры):
@@ -183,6 +187,8 @@ docker run --rm -i \
183
187
184
188
### Сообщения
185
189
190
+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_3)
191
+
186
192
- `whatsapp_send_message`— текстовое сообщение
187
193
- `whatsapp_send_file`— файл по URL
188
194
- `whatsapp_send_location`— геолокация
@@ -194,6 +200,8 @@ docker run --rm -i \
194
200
195
201
### Инстанс
196
202
203
+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_2)
204
+
197
205
- `whatsapp_get_state`— статус авторизации
198
206
- `whatsapp_get_settings`— текущие настройки
199
207
- `whatsapp_set_settings`— обновление настроек
@@ -203,12 +211,16 @@ docker run --rm -i \
203
211
204
212
### Контакты
205
213
214
+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_7)
215
+
206
216
- `whatsapp_get_contacts`— список контактов
207
217
- `whatsapp_get_contact_info`— информация о контакте
208
218
- `whatsapp_check_whatsapp`— проверка номера телефона на наличие WhatsApp
209
219
210
220
### Группы
211
221
222
+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_9)
223
+
212
224
- `whatsapp_create_group`— создание группы
213
225
- `whatsapp_get_group_data`— данные группы
214
226
- `whatsapp_add_group_participant`— добавление участника в группу
@@ -217,10 +229,14 @@ docker run --rm -i \
217
229
218
230
### Уведомления
219
231
232
+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_6)
0 commit comments