
msaelices/whatsapp-mcp-server
Developer tools이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기
MCP 소개 Python에서 구현된 서버
개요
FastMCP를 사용하여 WhatsApp Business API와 상호 작용하는 Model Context Protocol (MCP) 인터페이스를 제공하는 서버. WhatsApp에 Server는 Claude와 같은 언어 모델을 활성화하여 GreenAPI를 통해 WhatsApp 기능과 상호 작용합니다. 향상된 성능, 더 나은 개발자 경험 및 더 깨끗한 구현을 위해 FastMCP를 활용합니다. - : WhatsApp 연락처로 문자 메시지 보내기 - : 그룹 만들기, 목록 회원, 추가 / 데모 참가자 - : WhatsApp API 세션 관리 - : 채팅 목록 및 메시지 기록을 검색 이 프로젝트는 WhatsApp과 상호 작용하는 whatsapp-api-client-python 라이브러리를 사용합니다. 클라이언트는 GreenAPI 계정을 사용하려면 WhatsApp Cloud API에 액세스 할 수 있습니다. 이 프로젝트는 환경 변수를 사용하여 구성: - GREENAPI ID INSTANCE: 당신의 GreenAPI ID 인스턴스 - GREENAPI API TOKEN: 당신의 GreenAPI API 토큰 이 환경을 설정하거나 제공된 .env 파일 (설치 지침 참조)을 사용할 수 있습니다.
개요(AI 번역)
FastMCP를 사용하여 WhatsApp Business API와 상호 작용하는 Model Context Protocol (MCP) 인터페이스를 제공하는 서버.
소개
WhatsApp에 Server는 Claude와 같은 언어 모델을 활성화하여 GreenAPI를 통해 WhatsApp 기능과 상호 작용합니다. 향상된 성능, 더 나은 개발자 경험 및 더 깨끗한 구현을 위해 FastMCP를 활용합니다.
특징
-Messaging: WhatsApp에 메시지 보내기
- 그룹 관리: 그룹 만들기, 목록 회원, 추가/제거 -Session Handling: WhatsApp API 세션 관리 -Chat History: 채팅 리스트와 메시지 내역을 검색
WhatsApp API 클라이언트
이 프로젝트는 whatsapp-api-client-python 라이브러리를 사용하여 WhatsApp과 상호 작용합니다. 클라이언트는 GreenAPI 계정을 사용하려면 WhatsApp Cloud API에 액세스 할 수 있습니다.
환경 변수
이 프로젝트는 환경 변수를 사용하여 구성:
GREENAPI_ID_INSTANCE: GreenAPI ID 인스턴스GREENAPI_API_TOKEN: GreenAPI API 토큰
이 환경을 설정하거나 제공 된 .env] 파일 (설치 지침 참조)을 사용할 수 있습니다.
설치
사용법
이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요.
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 instanceGREENAPI_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 sessionsend_message: Send a message to a chatget_chats: Get a list of chatscreate_group: Create a new WhatsApp groupget_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
설치
docker run --rm -i -e GREENAPI_ID_INSTANCE=your_instance_id -e GREENAPI_API_TOKEN=your_api_token whatsapp-mcp-server설정
"mcpServers": {
"whatsapp": {
"command": "python",
"args": ["-m", "whatsapp_mcp"]
}
}