MW

msaelices/whatsapp-mcp-server

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

27 stars 9 forks Качество 67 Тренд 11MIT

WhatsApp MCP Сервер реализован на Python

Обзор

Сервер, который предоставляет интерфейс Model Context Protocol (MCP) для взаимодействия с WhatsApp Business API с использованием FastMCP. WhatsApp MCP Server - это реализация Python, которая позволяет языковым моделям, таким как Claude, взаимодействовать с функциональностью WhatsApp через GreenAPI. Он использует FastMCP для повышения производительности, лучшего опыта разработчиков и более чистой реализации. Отправляйте текстовые сообщения контактам WhatsApp: Создавайте группы, списывайте участников, добавляйте/удаляйте участников: Управляйте сессиями API WhatsApp: Восстанавливайте списки чатов и историю сообщений Этот проект использует библиотеку whatsapp-api-client-python для взаимодействия с WhatsApp. Клиент предоставляет доступ к API WhatsApp Cloud, для использования которого требуется учетная запись GreenAPI. Этот проект использует переменные среды для конфигурации: - GREENAPI ID INSTANCE: ваш идентификатор GreenAPI - GREENAPI API TOKEN: ваш маркер API GreenAPI Вы можете установить их в своей среде или использовать предоставленный файл .env (см. Инструкции по установке).

Обзор (машинный перевод)

Сервер, который предоставляет интерфейс Model Context Protocol (MCP) для взаимодействия с WhatsApp Business API с использованием FastMCP.

##Введение

WhatsApp MCP Server - это реализация Python, которая позволяет языковым моделям, таким как Claude, взаимодействовать с функциональностью WhatsApp через GreenAPI. Он использует FastMCP для повышения производительности, лучшего опыта разработчиков и более чистой реализации.

Особенности

Передача сообщений: отправка текстовых сообщений контактам WhatsApp Управление группой: Создание групп, список участников, добавление/удаление участников Управление сессией: управление сессиями API WhatsApp Chat History: Retrieve chat lists and message history

WhatsApp API клиент

Этот проект использует библиотеку T0 для взаимодействия с WhatsApp. Клиент предоставляет доступ к API WhatsApp Cloud, для использования которого требуется учетная запись GreenAPI.

Переменные среды

Этот проект использует переменные среды для конфигурации:

  • [[Т1]]: Идентификатор GreenAPI
  • [[Т2]]: Ваш токен GreenAPI API

Вы можете установить их в своей среде или использовать предоставленный файл .env (см. Инструкции по установке).

##Установка

Использование

Эта страница переведена автоматически. Технические детали смотрите в оригинале.

README

Показан фрагмент оригинального README. Открыть оригинал.

WhatsApp MCP Server

A server that provides a Model Context Protocol (MCP) interface to interact with WhatsApp Business API using FastMCP.

Introduction

WhatsApp MCP Server is a Python implementation that enables language models like Claude to interact with WhatsApp functionality through GreenAPI. It leverages FastMCP for improved performance, better developer experience, and a cleaner implementation.

Features

  • Messaging: Send text messages to WhatsApp contacts
  • Group Management: Create groups, list members, add/remove participants
  • Session Handling: Manage WhatsApp API sessions
  • Chat History: Retrieve chat lists and message history

WhatsApp API Client

This project uses the whatsapp-api-client-python library to interact with WhatsApp. The client provides access to the WhatsApp Cloud API, which requires a GreenAPI account to use.

Environment Variables

This project uses environment variables for configuration:

  • GREENAPI_ID_INSTANCE: Your GreenAPI ID instance
  • GREENAPI_API_TOKEN: Your GreenAPI API token

You can either set these in your environment or use the provided .env file (see Installation instructions).

Installation

# Clone the repository
git clone https://github.com/yourusername/whatsapp-mcp-server.git
cd whatsapp-mcp-server

# Install dependencies
pip install -e .

# Set up environment variables
cp .env-template .env
# Edit the .env file with your GreenAPI credentials

Usage

Run the MCP server:

# Run the MCP server on default host (127.0.0.1) and port (8000)
whatsapp-mcp

# Specify host and port
whatsapp-mcp --host 0.0.0.0 --port 9000

For debugging:

whatsapp-mcp --debug

The server communicates using the Model Context Protocol (MCP) and can be accessed via HTTP or WebSockets when running with FastMCP.

Available Tools

  • open_session: Open a new WhatsApp session
  • send_message: Send a message to a chat
  • get_chats: Get a list of chats
  • create_group: Create a new WhatsApp group
  • get_group_participants: Get the participants of a group

FastMCP API Reference

The WhatsApp MCP Server uses FastMCP to provide both WebSocket and HTTP endpoints:

  • WebSocket: ws://localhost:8000/mcp
  • HTTP: http://localhost:8000/mcp

You can test the API directly using tools like curl:

# List available tools
curl -X POST http://localhost:8000/mcp/listTools

# Call a tool
curl -X POST http://localhost:8000/mcp/callTool \
  -H "Content-Type: application/json" \
  -d '{"name": "open_session", "arguments": {}}'

How to add it to Claude Code

To add a WhatsApp server to Claude, use the claude mcp add command:

# Add the WhatsApp MCP server
$ claude mcp add whatsapp -- whatsapp-mcp

# List existing MCP servers - Validate that the server is running
claude mcp list

# Start claude code
claude

Using with Claude

Открыть полный README на GitHub

Установка

docker run --rm -i -e GREENAPI_ID_INSTANCE=your_instance_id -e GREENAPI_API_TOKEN=your_api_token whatsapp-mcp-server
Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

"mcpServers": { "whatsapp": { "command": "python", "args": ["-m", "whatsapp_mcp"] } }