How do I install Green API WhatsApp?

Copy the http config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Green API WhatsApp need an API key?

No required environment variable is listed on this record.

What transport does Green API WhatsApp use?

Green API WhatsApp is reached over HTTP.

When was Green API WhatsApp last checked?

Last checked 2026-10-23. MCP gateway for WhatsApp via Green API: messaging, contacts, groups and instance management.

Green API WhatsApp MCP server

Power your agent

Add this server

The publisher's own URL. Not a PlugMCP endpoint.

Add to Cursor Add in Claude Add to VS Code Run on PlugMCP

Host a copy with our keys and logs.

Server URL

https://mcp.green-api.com/mcp

The Claude button above opens Claude with the name and URL filled in. You still confirm it there.

shClaude Code

1claude mcp add --transport http com.green-api-whatsapp https://mcp.green-api.com/mcp

Run in a terminal.

jsonClaude Desktop

1{2  "mcpServers": {3    "com.green-api-whatsapp": {4      "command": "npx",5      "args": [6        "-y",7        "mcp-remote",8        "https://mcp.green-api.com/mcp"9      ]10    }11  }12}

claude_desktop_config.json

Remote · HTTPPublisher installStep-by-step: add this in Claude

Remote URL or a command on your machine? How the two installs differ

Run on PlugMCP

Host a copy with our keys and logs.

A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.

Launch

Server facts

Remote

Transport: http
Version: 0.1.2
Last checked

41 tools

Tools

tools/listVoice mode preview

Tool	What it does
whatsapp_add_group_participant	Add a participant to a WhatsApp group
whatsapp_check_whatsapp	Check whether a phone number has a WhatsApp account
whatsapp_connect	Connect a WhatsApp instance. Call this before using other tools. Validates credentials via getStateInstance.
whatsapp_create_group	Create a WhatsApp group
whatsapp_create_instance	Create a new WhatsApp instance via the GREEN-API Partner API
whatsapp_delete_instance	Delete a WhatsApp instance via the GREEN-API Partner API
whatsapp_delete_message	Delete a message
whatsapp_delete_notification	Delete a notification from the queue (acknowledge receipt)
whatsapp_disconnect	Disconnect a WhatsApp instance and remove credentials from the session
whatsapp_edit_message	Edit a previously sent message
whatsapp_forward_messages	Forward messages to another chat
whatsapp_get_authorization_code	Get an authorization code for sign-in by phone number
whatsapp_get_chat_history	Get chat message history. Use a small 'count' (default 50, max 100) to keep responses focused.
whatsapp_get_contact_avatar	Get the avatar of a contact or group
whatsapp_get_contact_info	Get information about a contact or group
whatsapp_get_contacts	Get the contact list
whatsapp_get_group_data	Get group data (members, name, invite link)
whatsapp_get_instances	List all partner instances via the GREEN-API Partner API
whatsapp_get_message	Get a message by ID
whatsapp_get_qr	Get the QR code for instance authorization. The result contains the QR as an image and a qrLink URL to an official GREEN-API page with a full-size auto-refreshing QR code. Always include the qrLink in your response as a clickable markdown link so the user can open it in the browser and scan comforta
whatsapp_get_settings	Get instance settings
whatsapp_get_state	Get instance state (authorized, notAuthorized, blocked, sleepMode)
whatsapp_get_wa_settings	Get WhatsApp account settings (name, description, etc.)
whatsapp_last_incoming_messages	Get recent incoming messages from the last N minutes (default 60, max 1440 = 24 hours).
whatsapp_last_outgoing_messages	Get recent outgoing messages from the last N minutes (default 60, max 1440 = 24 hours).
whatsapp_leave_group	Leave a WhatsApp group
whatsapp_logout	Log out the WhatsApp instance
whatsapp_read_chat	Mark chat messages as read
whatsapp_reboot	Reboot the WhatsApp instance
whatsapp_receive_notification	Get one notification from the queue (manual polling)
whatsapp_remove_group_admin	Revoke admin rights from a group member
whatsapp_remove_group_participant	Remove a participant from a WhatsApp group
whatsapp_send_contact	Send a contact card via WhatsApp
whatsapp_send_file	Send a file by URL
whatsapp_send_file_by_upload	Send a file directly to a chat via multipart upload (no separate URL step)
whatsapp_send_location	Send a location
whatsapp_send_message	Send a text message via WhatsApp
whatsapp_send_poll	Send a poll via WhatsApp
whatsapp_set_group_admin	Promote a group member to admin
whatsapp_set_settings	Update instance settings (webhooks, proxy, etc.)
whatsapp_upload_file	Upload a file to GREEN-API storage and return its URL. Use the returned URL with whatsapp_send_file.

green-api-mcp-gateway

Документация на русском

Support Links

Guides & News

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.

What it does

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.

Instructions for connecting the MCP server can be found on our website

Architecture

Clean Architecture (Ports & Adapters):

cmd/server/main.go                    — entry point, DI wiring
internal/
  domain/                             — business entities, errors, constants (zero dependencies)
  application/                        — ports (interfaces)
  infrastructure/
    auth.go                           — CredentialManager (in-memory credential store)
    config/config.go                  — YAML + env configuration
    greenapi/client.go                — WhatsApp client via Go SDK
    mcp/
      server.go                       — MCP server (stdio/sse)
      tools.go                        — MCP tools registration
      resources.go                    — MCP resources
      prompts.go                      — MCP prompts
    webhook/
      bridge.go                       — polling bridge
      receiver.go                     — HTTP receiver

Build

go build -o green-api-mcp-gateway ./cmd/server

Requires Go 1.25+.

Transports & endpoints

The server supports four transports, selected via server.transport (or the GREEN_API_TRANSPORT env var):

Transport	Endpoints (relative to `host:port`)	Use case
`stdio`	stdin/stdout	Local CLIs (Claude Desktop, Cursor) launching the binary.
`sse`	`GET /` (stream) + `POST /message`	Legacy MCP clients (SSE only).
`http`	`POST/GET /mcp`	Streamable HTTP (MCP 2025-03-26+) — preferred for new clients.
`hybrid`	`/sse` + `/message` and `/mcp` on one port	Public server: serves both legacy SSE and Streamable HTTP.

All HTTP-based transports also expose:

GET /health, GET /healthz — health probes (no auth)
GET /favicon.ico, GET /favicon.png — GREEN-API icon

When auth.mode: proxy is enabled, the OAuth 2.0 PKCE endpoints are added too:

GET /.well-known/oauth-authorization-server — RFC 8414 metadata
GET /.well-known/oauth-protected-resource — RFC 9728 metadata
GET /authorize — browser-facing authorization form
POST /token — token exchange

Configuration

Via YAML

server:
  transport: stdio   # stdio | sse | http | hybrid
  port: 8090

auth:
  mode: config       # config | proxy
  cache_ttl: 300     # seconds (proxy mode only)

green_api:
  instances:
    - id: 1101000001
      api_token: "YOUR_TOKEN"
      api_url: "https://api.green-api.com"

webhook:
  mode: polling
  polling_timeout: 20

rate_limit:
  requests_per_second: 10
  burst: 20

logging:
  level: info
  format: text

Via environment variables

Environment variables take precedence over the YAML config:

The variables below cover both deployment modes. Credentials variables (GREEN_API_INSTANCE_ID, GREEN_API_TOKEN, GREEN_API_URL) apply only to local stdio runs with auth.mode: config. For HTTP transports (sse on /sse + /message, http on /mcp, or hybrid) use auth.mode: proxy instead — credentials arrive in HTTP headers or via the built-in OAuth flow and the env credentials are ignored.

GREEN_API_INSTANCE_ID — instance ID
GREEN_API_TOKEN — API token
GREEN_API_URL — API base URL (defaults to https://api.green-api.com)
GREEN_API_TRANSPORT — transport: stdio, sse, http, or hybrid
GREEN_API_PORT — HTTP port (defaults to 8090)
GREEN_API_BASE_URL — public base URL (used for OAuth issuer/redirects, e.g. https://mcp.example.com)
GREEN_API_WIDGET_DOMAIN — unique widget origin for ChatGPT Apps submission metadata (defaults to GREEN_API_BASE_URL, then https://mcp.green-api.com)
GREEN_API_AUTH_MODE — config or proxy
GREEN_API_AUTH_CACHE_TTL — proxy-auth credential cache TTL (seconds)
GREEN_API_WEBHOOK_MODE — polling or receiver
LOG_LEVEL — log level
LOG_FORMAT — text or json

Run

# With environment variables
export GREEN_API_INSTANCE_ID=1101000001
export GREEN_API_TOKEN=your_token
./green-api-mcp-gateway

# With a config file
./green-api-mcp-gateway --config config.yaml

Integration

Claude Desktop (local stdio)

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "whatsapp": {
      "command": "/path/to/green-api-mcp-gateway",
      "args": ["--config", "/path/to/config.yaml"]
    }
  }
}

OpenClaw

mcp:
  servers:
    - name: whatsapp
      command: /path/to/green-api-mcp-gateway
      args: ["--config", "/path/to/config.yaml"]

Docker

docker build -t green-api-mcp-gateway .

docker run --rm -i \
  -e GREEN_API_INSTANCE_ID=1101000001 \
  -e GREEN_API_TOKEN=your_token \
  green-api-mcp-gateway

MCP Tools

Messaging

Link to documentation

whatsapp_send_message — text message
whatsapp_send_file — file by URL
whatsapp_send_location — location
whatsapp_send_contact — contact (vCard)
whatsapp_send_poll — poll
whatsapp_forward_messages — forward
whatsapp_edit_message — edit
whatsapp_delete_message — delete

Instance

Link to documentation

whatsapp_get_state — authorization state
whatsapp_get_settings — current settings
whatsapp_set_settings — update settings
whatsapp_get_qr — authorization QR code
whatsapp_connect — connect instance
whatsapp_disconnect — disconnect instance

Contacts

Link to documentation

whatsapp_get_contacts — contact list
whatsapp_get_contact_info — contact information
whatsapp_check_whatsapp — phone number check

Groups

Link to documentation

whatsapp_create_group — create a group
whatsapp_get_group_data — group data
whatsapp_add_group_participant — add a participant
whatsapp_remove_group_participant — remove a participant
whatsapp_leave_group — leave a group

Notifications

Link to documentation

whatsapp_receive_notification — receive an incoming notification (long-poll)

Partner API

Link to documentation

whatsapp_create_instance — create an instance
whatsapp_delete_instance — delete an instance
whatsapp_get_instances — list instances

MCP Resources

whatsapp://instance/{id}/state — instance state
whatsapp://instance/{id}/settings — instance settings

MCP Prompts

whatsapp_customer_support — template for customer support
whatsapp_broadcast — template for broadcast messaging

Dependencies

mcp-go — MCP SDK
whatsapp-api-client-golang — GREEN-API Go SDK

Development

go test ./...
gofmt -w .
GOOS=linux GOARCH=amd64 go build -o green-api-mcp-gateway-linux ./cmd/server

License

MIT — see LICENSE.

Green API WhatsApp

Add this server

Host a copy with our keys and logs.

Server facts

Tools

Questions

How do I install Green API WhatsApp?

Does Green API WhatsApp need an API key?

What transport does Green API WhatsApp use?

When was Green API WhatsApp last checked?

Documentation

green-api-mcp-gateway

Support Links

Guides & News

What it does

Architecture

Build

Transports & endpoints

Configuration

Via YAML

Via environment variables

Run

Integration

Claude Desktop (local stdio)

OpenClaw

Docker

MCP Tools

Messaging

Instance

Contacts

Groups

Notifications

Partner API

MCP Resources

MCP Prompts

Dependencies

Development

License