# GREEN-API WhatsApp MCP server

> Send WhatsApp messages, manage groups and contacts, and administer GREEN-API instances from an AI assistant.

- Listing: https://mcp.tc/i/green-api-whatsapp
- Connect: use the server's own URL `https://mcp.green-api.com/mcp` (with your API key); clients connect to it directly. The listing link is a page, not an MCP endpoint.
- Type: remote (Streamable HTTP)
- Auth: API key
- Category: [Communication & Meetings](https://mcp.tc/c/communication)
- Vendor: GREEN-API
- Homepage: <https://green-api.com/>
- Repository: <https://github.com/green-api/green-api-mcp-gateway>

## About

Connects an assistant to WhatsApp through GREEN-API. It can send text, files, locations, contacts and polls, edit, forward and delete messages, read chat history and recent messages, manage groups, check whether numbers have WhatsApp, and manage instances, including the Partner API for creating and deleting them.

Runs as a hosted streamable HTTP endpoint (with a legacy SSE endpoint), or as a local Go binary over stdio. The hosted endpoint takes a GREEN-API instance ID and instance token as the X-Instance-Id and X-Api-Token headers. The README also mentions a built-in OAuth flow in proxy mode.

## What it can do

- Send text, files, locations, contacts and polls
- Edit, forward and delete messages
- Read chat history and recent incoming or outgoing messages
- Create groups and manage participants and admins
- Check whether phone numbers have WhatsApp
- View and update instance settings, state and QR code
- Create, list and delete partner instances

## Tools (41)

- `whatsapp_add_group_participant`: Add a participant to a WhatsApp group
- `whatsapp_check_whatsapp`: Check whether a phone number has a WhatsApp account (read-only)
- `whatsapp_connect`: Connect a WhatsApp instance and validate credentials
- `whatsapp_create_group`: Create a WhatsApp group
- `whatsapp_create_instance`: Create a new instance via the Partner API
- `whatsapp_delete_instance`: Delete an instance via the Partner API (can modify or delete data)
- `whatsapp_delete_message`: Delete a message (can modify or delete data)
- `whatsapp_delete_notification`: Delete a notification from the queue (can modify or delete data)
- `whatsapp_disconnect`: Disconnect an instance and remove its credentials from the session
- `whatsapp_edit_message`: Edit a previously sent message (can modify or delete data)
- `whatsapp_forward_messages`: Forward messages to another chat (can modify or delete data)
- `whatsapp_get_authorization_code`: Get an authorization code for sign-in by phone number (read-only)
- `whatsapp_get_chat_history`: Get chat message history (read-only)
- `whatsapp_get_contact_avatar`: Get the avatar of a contact or group (read-only)
- `whatsapp_get_contact_info`: Get information about a contact or group (read-only)
- `whatsapp_get_contacts`: Get the contact list (read-only)
- `whatsapp_get_group_data`: Get group members, name and invite link (read-only)
- `whatsapp_get_instances`: List partner instances (read-only)
- `whatsapp_get_message`: Get a message by ID (read-only)
- `whatsapp_get_qr`: Get the QR code for instance authorization (read-only)
- `whatsapp_get_settings`: Get instance settings (read-only)
- `whatsapp_get_state`: Get instance state such as authorized or blocked (read-only)
- `whatsapp_get_wa_settings`: Get WhatsApp account settings (read-only)
- `whatsapp_last_incoming_messages`: Get incoming messages from the last N minutes (read-only)
- `whatsapp_last_outgoing_messages`: Get outgoing messages from the last N minutes (read-only)
- `whatsapp_leave_group`: Leave a WhatsApp group (can modify or delete data)
- `whatsapp_logout`: Log out the WhatsApp instance (can modify or delete data)
- `whatsapp_read_chat`: Mark chat messages as read
- `whatsapp_reboot`: Reboot the WhatsApp instance
- `whatsapp_receive_notification`: Get one notification from the queue by polling (read-only)
- `whatsapp_remove_group_admin`: Revoke admin rights from a group member (can modify or delete data)
- `whatsapp_remove_group_participant`: Remove a participant from a group (can modify or delete data)
- `whatsapp_send_contact`: Send a contact card (can modify or delete data)
- `whatsapp_send_file`: Send a file by URL (can modify or delete data)
- `whatsapp_send_file_by_upload`: Send a file directly via multipart upload (can modify or delete data)
- `whatsapp_send_location`: Send a location (can modify or delete data)
- `whatsapp_send_message`: Send a text message (can modify or delete data)
- `whatsapp_send_poll`: Send a poll (can modify or delete data)
- `whatsapp_set_group_admin`: Promote a group member to admin
- `whatsapp_set_settings`: Update instance settings such as webhooks (can modify or delete data)
- `whatsapp_upload_file`: Upload a file to GREEN-API storage and return its URL.

## Example prompts

- "Send a WhatsApp message to 15551234567 saying the order has shipped"
- "Show messages received in the last 2 hours"
- "Create a WhatsApp group called Project Team with these numbers"
- "Check whether +49 170 1234567 is on WhatsApp"

## Install

### Claude Code

1. Run this in a terminal, in your project folder:

```bash
claude mcp add --transport http green-api-whatsapp https://mcp.green-api.com/mcp --header "X-Instance-Id: <YOUR_X_INSTANCE_ID>" --header "X-Api-Token: <YOUR_X_API_TOKEN>"
```

2. Replace the placeholder with your key before you run it, then check it with `/mcp` inside Claude Code.

Add `--scope user` to make it available in every project, not just this one.

### Claude Desktop

1. Use the `mcp-remote` bridge, which keeps the key on this computer (a connector added on claude.ai with the key under **Request headers** also shows up here). Open **Settings → Developer → Edit Config** and add:

`claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "green-api-whatsapp": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.green-api.com/mcp",
        "--header",
        "X-Instance-Id: <YOUR_X_INSTANCE_ID>",
        "--header",
        "X-Api-Token: <YOUR_X_API_TOKEN>"
      ]
    }
  }
}
```

2. Replace the placeholder with your key and restart Claude Desktop.

The bridge needs Node.js on your computer.

### claude.ai

1. Open the connector form on claude.ai. This button fills in the name and URL for you:

[Add to claude.ai](<https://claude.ai/customize/connectors?modal=add-custom-connector&connectorName=GREEN-API%20WhatsApp&connectorUrl=https%3A%2F%2Fmcp.green-api.com%2Fmcp>) (opens connector settings)

2. Check that the URL reads `https://mcp.green-api.com/mcp`. Under **Request headers**, add `X-Instance-Id: <YOUR_X_INSTANCE_ID>` and `X-Api-Token: <YOUR_X_API_TOKEN>` with your key from GREEN-API, then click **Add**.

3. Turn it on in a chat from the tools menu.

Free plans allow one custom connector. On Team and Enterprise plans an owner adds it under **Organization settings → Connectors**.

### Cursor

[Add to Cursor](<https://cursor.com/install-mcp?name=green-api-whatsapp&config=eyJ1cmwiOiJodHRwczovL21jcC5ncmVlbi1hcGkuY29tL21jcCIsImhlYWRlcnMiOnsiWC1JbnN0YW5jZS1JZCI6IjxZT1VSX1hfSU5TVEFOQ0VfSUQ%2BIiwiWC1BcGktVG9rZW4iOiI8WU9VUl9YX0FQSV9UT0tFTj4ifX0%3D>) (opens Cursor)

Or add it by hand to `~/.cursor/mcp.json` (all projects) or `.cursor/mcp.json` (this project):

`mcp.json`:

```json
{
  "mcpServers": {
    "green-api-whatsapp": {
      "url": "https://mcp.green-api.com/mcp",
      "headers": {
        "X-Instance-Id": "<YOUR_X_INSTANCE_ID>",
        "X-Api-Token": "<YOUR_X_API_TOKEN>"
      }
    }
  }
}
```

### VS Code

Add it to `.vscode/mcp.json`. VS Code asks for the key the first time and stores it securely:

`.vscode/mcp.json`:

```json
{
  "servers": {
    "green-api-whatsapp": {
      "type": "http",
      "url": "https://mcp.green-api.com/mcp",
      "headers": {
        "X-Instance-Id": "${input:x-instance-id}",
        "X-Api-Token": "${input:x-api-token}"
      }
    }
  },
  "inputs": [
    {
      "type": "promptString",
      "id": "x-instance-id",
      "description": "X-Instance-Id",
      "password": true
    },
    {
      "type": "promptString",
      "id": "x-api-token",
      "description": "X-Api-Token",
      "password": true
    }
  ]
}
```

### Devin Desktop

1. Add it to `~/.config/devin/mcp_config.json` (macOS and Linux) or `%APPDATA%\devin\mcp_config.json` (Windows):

`mcp_config.json`:

```json
{
  "mcpServers": {
    "green-api-whatsapp": {
      "serverUrl": "https://mcp.green-api.com/mcp",
      "headers": {
        "X-Instance-Id": "<YOUR_X_INSTANCE_ID>",
        "X-Api-Token": "<YOUR_X_API_TOKEN>"
      }
    }
  }
}
```

2. Refresh the MCP server list in Cascade.

Devin Desktop is the new name for Windsurf. It reads `serverUrl` (or `url`) for remote servers.

### Codex

```bash
codex mcp add green-api-whatsapp --url https://mcp.green-api.com/mcp
```

`codex mcp add` can’t set the `X-Instance-Id` and `X-Api-Token` headers, so this step is required: put this entry in `~/.codex/config.toml` instead of running the command, or add its `env_http_headers` line to the entry the command made:

`config.toml`:

```toml
[mcp_servers.green-api-whatsapp]
url = "https://mcp.green-api.com/mcp"
env_http_headers = { "X-Instance-Id" = "X_INSTANCE_ID", "X-Api-Token" = "X_API_TOKEN" }
```

Codex reads the header values from the environment variables named in `env_http_headers`.

### Gemini CLI

```bash
gemini mcp add --transport http --header "X-Instance-Id: <YOUR_X_INSTANCE_ID>" --header "X-Api-Token: <YOUR_X_API_TOKEN>" green-api-whatsapp https://mcp.green-api.com/mcp
```

This adds it to the current project. Add `-s user` to use it everywhere.

### Any client

Most clients accept this shape. Some name the URL field differently: `serverUrl` in Devin Desktop, `httpUrl` in Gemini CLI’s settings file.

```json
{
  "mcpServers": {
    "green-api-whatsapp": {
      "type": "http",
      "url": "https://mcp.green-api.com/mcp",
      "headers": {
        "X-Instance-Id": "<YOUR_X_INSTANCE_ID>",
        "X-Api-Token": "<YOUR_X_API_TOKEN>"
      }
    }
  }
}
```

Zed puts servers under `context_servers` in its settings. Cline needs `"type": "streamableHttp"`, or it assumes SSE.

Client only starts local servers? Bridge it with `npx -y mcp-remote https://mcp.green-api.com/mcp`.

## Recent changes

- 2026-10-10 04:25 UTC: Tracking started: 41 tools read. Source: automatic check.

More on the History tab, with descriptions before and after for the newest entries: https://mcp.tc/i/green-api-whatsapp#history (Atom feed: https://mcp.tc/i/green-api-whatsapp/history.xml). It records what mcp.tc's anonymous checks saw, every 3 hours where the tool list can be read without sign-in; it is not a security review.

## Details

- Server version: dev
- MCP protocol version: 2025-11-25
- Last checked: 2026-11-18 (reachable, asks for credentials)
- Listed: 2026-10-10
- Updated: 2026-10-10

---
Source: https://mcp.tc/i/green-api-whatsapp (mcp.tc is an independent directory, not affiliated with this server's publisher). Corrections: https://mcp.tc/report
