Skip to content

Commit 89e9ab6

Browse files
authored
Merge pull request #2 from green-api/chore/add-docs-links
chore: add docs links
2 parents 9b80102 + 6a8dc10 commit 89e9ab6

2 files changed

Lines changed: 34 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# green-api-mcp-gateway
22

3-
- [Документация на русском](README_RU.md)
4-
53
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
64
[![Go Version](https://img.shields.io/github/go-mod/go-version/green-api/green-api-mcp-gateway/main)](https://go.dev/)
75
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/green-api/green-api-mcp-gateway?label=release)](https://github.com/green-api/green-api-mcp-gateway/tags)
86
[![Protocol: MCP](https://img.shields.io/badge/Protocol-MCP-orange.svg)](https://modelcontextprotocol.io)
97
[![Go Report Card](https://goreportcard.com/badge/github.com/green-api/green-api-mcp-gateway)](https://goreportcard.com/report/github.com/green-api/green-api-mcp-gateway)
108

9+
- [Документация на русском](README_RU.md)
10+
1111
## Support Links
1212

1313
[![Support](https://img.shields.io/badge/support@green--api.com-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:support@green-api.com)
@@ -20,12 +20,16 @@
2020
[![News](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/green_api)
2121
[![News](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://whatsapp.com/channel/0029VaLj6J4LNSa2B5Jx6s3h)
2222

23+
---
24+
2325
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).
2426

2527
## What it does
2628

2729
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.
2830

31+
Instructions for connecting the MCP server can be found on [our website](https://green-api.com/en/docs/integration/mcp/integration-setup/)
32+
2933
## Architecture
3034

3135
Clean Architecture (Ports & Adapters):
@@ -184,6 +188,8 @@ docker run --rm -i \
184188

185189
### Messaging
186190

191+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#sending-messages)
192+
187193
- `whatsapp_send_message` — text message
188194
- `whatsapp_send_file` — file by URL
189195
- `whatsapp_send_location` — location
@@ -195,6 +201,8 @@ docker run --rm -i \
195201

196202
### Instance
197203

204+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#instance-management)
205+
198206
- `whatsapp_get_state` — authorization state
199207
- `whatsapp_get_settings` — current settings
200208
- `whatsapp_set_settings` — update settings
@@ -204,12 +212,16 @@ docker run --rm -i \
204212

205213
### Contacts
206214

215+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#contacts)
216+
207217
- `whatsapp_get_contacts` — contact list
208218
- `whatsapp_get_contact_info` — contact information
209219
- `whatsapp_check_whatsapp` — phone number check
210220

211221
### Groups
212222

223+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#groups)
224+
213225
- `whatsapp_create_group` — create a group
214226
- `whatsapp_get_group_data` — group data
215227
- `whatsapp_add_group_participant` — add a participant
@@ -218,10 +230,14 @@ docker run --rm -i \
218230

219231
### Notifications
220232

233+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#notification-queue)
234+
221235
- `whatsapp_receive_notification` — receive an incoming notification (long-poll)
222236

223237
### Partner API
224238

239+
[*Link to documentation*](https://green-api.com/en/docs/integration/mcp/tools/#partner-api)
240+
225241
- `whatsapp_create_instance` — create an instance
226242
- `whatsapp_delete_instance` — delete an instance
227243
- `whatsapp_get_instances` — list instances

README_RU.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,16 @@
1818
[![News](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/green_api)
1919
[![News](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://whatsapp.com/channel/0029VaHUM5TBA1f7cG29nO1C)
2020

21+
---
22+
2123
MCP-шлюз для GREEN-API WhatsApp. Позволяет агентам ИИ (Claude Desktop, OpenClaw, Cursor и другие) отправлять сообщения, управлять инстансами и получать уведомления через WhatsApp, используя [Model Context Protocol](https://modelcontextprotocol.io).
2224

2325
## Функциональные возможности
2426

2527
Отправка текстовых сообщений, файлов по URL, геолокаций, контактов и опросов. Пересылка и редактирование сообщений. Создание групп, получение данных о группах, добавление и удаление участников. Проверка номеров телефонов на наличие WhatsApp, получение списка контактов и информации о них. Получение статуса и настроек инстанса, генерация QR-кода для авторизации. Получение входящих уведомлений через метод длинных опросов (polling) или HTTP-вебхуки (receiver). Создание и удаление инстансов. Поддержка работы с несколькими инстансами в рамках одного шлюза. Готовые шаблоны для распространенных сценариев (клиентская поддержка, рассылки). Метрики Prometheus и интеграция с OpenTelemetry.
2628

29+
С инструкцией по подключению MCP сервера можно ознакомиться [на нашем сайте](https://green-api.com/docs/integration/mcp/integration-setup/)
30+
2731
## Архитектура
2832

2933
Чистая Архитектура (Порты и Адаптеры):
@@ -183,6 +187,8 @@ docker run --rm -i \
183187

184188
### Сообщения
185189

190+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_3)
191+
186192
- `whatsapp_send_message` — текстовое сообщение
187193
- `whatsapp_send_file` — файл по URL
188194
- `whatsapp_send_location` — геолокация
@@ -194,6 +200,8 @@ docker run --rm -i \
194200

195201
### Инстанс
196202

203+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_2)
204+
197205
- `whatsapp_get_state` — статус авторизации
198206
- `whatsapp_get_settings` — текущие настройки
199207
- `whatsapp_set_settings` — обновление настроек
@@ -203,12 +211,16 @@ docker run --rm -i \
203211

204212
### Контакты
205213

214+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_7)
215+
206216
- `whatsapp_get_contacts` — список контактов
207217
- `whatsapp_get_contact_info` — информация о контакте
208218
- `whatsapp_check_whatsapp` — проверка номера телефона на наличие WhatsApp
209219

210220
### Группы
211221

222+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_9)
223+
212224
- `whatsapp_create_group` — создание группы
213225
- `whatsapp_get_group_data` — данные группы
214226
- `whatsapp_add_group_participant` — добавление участника в группу
@@ -217,10 +229,14 @@ docker run --rm -i \
217229

218230
### Уведомления
219231

232+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#_6)
233+
220234
- `whatsapp_receive_notification` — получение входящего уведомления (long-poll)
221235

222236
### Партнёрские методы
223237

238+
[*Ссылка на документацию*](https://green-api.com/docs/integration/mcp/tools/#api)
239+
224240
- `whatsapp_create_instance` — создание инстанса
225241
- `whatsapp_delete_instance` — удаление инстанса
226242
- `whatsapp_get_instances` — список инстансов

0 commit comments

Comments
 (0)