# Green API WhatsApp > Lets your agent send and read WhatsApp messages and manage groups and contacts via Green API, an unofficial third-party WhatsApp gateway. Green API's own hosted MCP server lets your agent use WhatsApp through Green API (green-api.com). Green API is an unofficial, third-party WhatsApp gateway, not Meta's official WhatsApp Business Platform. You link your own WhatsApp number to a Green API instance, much as you would link WhatsApp Web, and your agent works through that instance. What you can do with it - Send text messages, files, locations, contact cards and polls to a chat or a group - Read chat history and your recent incoming and outgoing messages, and mark chats as read - Forward, edit and delete messages - Check whether a number is on WhatsApp, and look up your contacts - Create groups, add or remove participants and set admins - Check your instance's state, change its settings and get the QR code to link a number How it connects Add https://mcp.green-api.com/mcp as a remote server, with the instance ID and API token from your Green API console as the X-Instance-Id and X-Api-Token headers. In Claude Desktop you can add it as a custom connector instead and enter them in a browser sign-in. You need a Green API account on one of its plans and an authorized instance. Green API also publishes the gateway's source (MIT) if you'd rather run it yourself. Good to know - WhatsApp's terms forbid linking your account to unofficial apps and sending bulk or automated messages, and WhatsApp says accounts that do so can be temporarily or permanently banned. - Green API itself warns that WhatsApp blocks numbers for unsolicited messages and mass mailings, so only message people who expect to hear from you. - After you connect, Green API lets you allow or block the methods it considers potentially unsafe. - Type: Plugin - Made by: Green API - Category: Communication - Formats: Remote MCP - Version: 0.1.2 - Website: https://green-api.com/en/docs/integration/mcp/integration-setup/ - Source: https://github.com/green-api/green-api-mcp-gateway - Page: https://pluginboard.ai/plugins/green-api-whatsapp ## Works with - ChatGPT - Claude - Muse - Grok Bot - Gemini - Grok - GitHub Copilot - Cursor - Claude Code - Codex - Antigravity - Gemini CLI - Replit - OpenClaw - OpenCode - Hermes Agent ## Install You'll need: - `X-Instance-Id` (required): Green API instance ID - `X-Api-Token` (required): Green API instance token Replace each `` placeholder with your own value. ### ChatGPT In ChatGPT on the web: Plugins → + → Add custom MCP server, then paste https://mcp.green-api.com/mcp under Connection. Business and Enterprise plans; Pro can add read-only servers. ### Claude In Claude (web or desktop): Customize → Connectors → Add custom connector, then paste https://mcp.green-api.com/mcp ### Muse In Muse: In a Muse chat, ask it to create a custom connector for the MCP server at https://mcp.green-api.com/mcp. Then tap Connect on the card it shows and sign in, or add your key. ### Grok Bot In Grok Bot: In a chat with your Bot, say "Add this MCP server: https://mcp.green-api.com/mcp". It confirms the details with you and sets it up, and the tools are ready from your next message. ### Grok In Grok on the web: At grok.com/connectors: New Connector → Custom, then enter https://mcp.green-api.com/mcp and sign in if it asks. ### GitHub Copilot Add to VS Code: vscode:mcp/install?%7B%22name%22%3A%22green-api-whatsapp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.green-api.com%2Fmcp%22%7D Copilot CLI: ```shell copilot mcp add --transport http --header 'X-Instance-Id: ' --header 'X-Api-Token: ' green-api-whatsapp https://mcp.green-api.com/mcp ``` ### Cursor Add to Cursor: cursor://anysphere.cursor-deeplink/mcp/install?name=green-api-whatsapp&config=eyJ1cmwiOiJodHRwczovL21jcC5ncmVlbi1hcGkuY29tL21jcCIsImhlYWRlcnMiOnsiWC1JbnN0YW5jZS1JZCI6IjxYLUluc3RhbmNlLUlkPiIsIlgtQXBpLVRva2VuIjoiPFgtQXBpLVRva2VuPiJ9fQ%3D%3D Add to .cursor/mcp.json: ```json { "mcpServers": { "green-api-whatsapp": { "url": "https://mcp.green-api.com/mcp", "headers": { "X-Instance-Id": "", "X-Api-Token": "" } } } } ``` ### Claude Code Run in your terminal: ```shell claude mcp add --transport http --header 'X-Instance-Id: ' --header 'X-Api-Token: ' green-api-whatsapp https://mcp.green-api.com/mcp ``` ### Codex Run in your terminal: ```shell codex mcp add green-api-whatsapp --url https://mcp.green-api.com/mcp ``` ### Antigravity Add to ~/.gemini/config/mcp_config.json: ```json { "mcpServers": { "green-api-whatsapp": { "url": "https://mcp.green-api.com/mcp", "headers": { "X-Instance-Id": "", "X-Api-Token": "" } } } } ``` ### Gemini CLI Run in your terminal: ```shell gemini mcp add --transport http --header 'X-Instance-Id: ' --header 'X-Api-Token: ' green-api-whatsapp https://mcp.green-api.com/mcp ``` ### Replit In Replit: At replit.com/integrations, open MCP Servers → + Add MCP server, paste https://mcp.green-api.com/mcp (add any headers under Advanced settings), then click Test & save. ### OpenClaw Run in your terminal: ```shell openclaw mcp add green-api-whatsapp --url https://mcp.green-api.com/mcp --transport streamable-http ``` If it needs a key or sign-in: For https://mcp.green-api.com/mcp, add --header NAME=value for each header it needs, or --auth oauth and then run openclaw mcp login green-api-whatsapp. ### OpenCode Run in your terminal: ```shell opencode mcp add green-api-whatsapp --url https://mcp.green-api.com/mcp ``` If it needs a key: For https://mcp.green-api.com/mcp, add --header 'NAME=value' for each header it needs. Add --global to use it in every project. ### Hermes Agent Run in your terminal: ```shell hermes mcp add green-api-whatsapp --url https://mcp.green-api.com/mcp ``` Add to ~/.hermes/config.yaml: ```json { "mcp_servers": { "green-api-whatsapp": { "url": "https://mcp.green-api.com/mcp", "headers": { "X-Instance-Id": "", "X-Api-Token": "" } } } } ``` If it signs in with OAuth: If https://mcp.green-api.com/mcp asks you to sign in, add --auth oauth to the command, or auth: oauth to its entry. --- From Pluginboard (https://pluginboard.ai).