# Whatsapp Osint MCP Server
English | [简体中文](./README.md) | [繁體中文](./README_ZH-TW.md)
An MCP server for accessing Whatsapp Osint API.
## 🚀 Quick Start with EMCP Platform
**[EMCP](https://sit-emcp.kaleido.guru)** is a powerful MCP server management platform that allows you to quickly use various MCP servers without manual configuration!
### Quick Start:
1. 🌐 Visit **[EMCP Platform](https://sit-emcp.kaleido.guru)**
2. 📝 Register and login
3. 🎯 Go to **MCP Marketplace** to browse all available MCP servers
4. 🔍 Search or find this server (`bach-whatsapp_osint`)
5. 🎉 Click the **"Install MCP"** button
6. ✅ Done! You can now use it in your applications
### EMCP Platform Advantages:
- ✨ **Zero Configuration**: No need to manually edit config files
- 🎨 **Visual Management**: Easy-to-use GUI for managing all MCP servers
- 🔐 **Secure & Reliable**: Centralized API key and authentication management
- 🚀 **One-Click Install**: Rich selection of servers in MCP Marketplace
- 📊 **Usage Statistics**: Real-time service call monitoring
Visit **[EMCP Platform](https://sit-emcp.kaleido.guru)** now to start your MCP journey!
---
## Introduction
This is an MCP server for accessing the Whatsapp Osint API.
- **PyPI Package**: `bach-whatsapp_osint`
- **Version**: 1.0.0
- **Transport Protocol**: stdio
## 安装
### 从 PyPI 安装:
```bash
pip install bach-whatsapp_osint
```
### 从源码安装:
```bash
pip install -e .
```
## 运行
### 方式 1: 使用 uvx（推荐，无需安装）
```bash
# 运行（uvx 会自动安装并运行）
uvx --from bach-whatsapp_osint bach_whatsapp_osint
# 或指定版本
uvx --from bach-whatsapp_osint@latest bach_whatsapp_osint
```
### 方式 2: 直接运行（开发模式）
```bash
python server.py
```
### 方式 3: 安装后作为命令运行
```bash
# 安装
pip install bach-whatsapp_osint
# 运行（命令名使用下划线）
bach_whatsapp_osint
```
## Configuration
### API Authentication
This API requires authentication. Please set environment variable:
```bash
export API_KEY="your_api_key_here"
```
### Environment Variables
| Variable | Description | Required |
|----------|-------------|----------|
| `API_KEY` | API Key | Yes |
| `PORT` | N/A | No |
| `HOST` | N/A | No |
### Using with Cursor
Edit Cursor MCP config file `~/.cursor/mcp.json`:
```json
{
"mcpServers": {
"bach-whatsapp_osint": {
"command": "uvx",
"args": ["--from", "bach-whatsapp_osint", "bach_whatsapp_osint"],
"env": {
"API_KEY": "your_api_key_here"
}
}
}
}
```
### Using with Claude Desktop
Edit Claude Desktop config file `claude_desktop_config.json`:
```json
{
"mcpServers": {
"bach-whatsapp_osint": {
"command": "uvx",
"args": ["--from", "bach-whatsapp_osint", "bach_whatsapp_osint"],
"env": {
"API_KEY": "your_api_key_here"
}
}
}
}
```
## 可用工具
此服务器提供以下工具:
### `business_insights`
This endpoint returns business status and verified name for an array of WhatsApp numbers.
**端点**: `POST /bizos`
---
### `status`
Whatsapp user's status info.
**端点**: `GET /about`
**参数**:
- `phone` (number) *必需*: Enter phone number with country code and no special characters.
---
### `devices`
Returns the number of linked devices. Max number of linked devices is 4.
**端点**: `GET /devices`
**参数**:
- `phone` (number) *必需*: Provide the phone number in international format without the + sign (as required by Meta/WhatsApp). Use digits only—no spaces or symbols. Example: 34911222333 (ES), 13022612667 (US), 447911123456 (UK). The result will show how many devices are linked to this WhatsApp account (up to 4).
---
### `privacy_settings`
Fetch user privacy settings
**端点**: `GET /privacy`
**参数**:
- `phone` (number) *必需*: Provide the phone number in international format without the + sign and using digits only—no spaces or symbols. Examples: 34911222333 (ES), 13022612667 (US), 447911123456 (UK). The response returns the account’s current privacy settings. Privacy settings depend on the user configuration.
---
### `base64_encoded_profile`
Fetch the base64 encoded file of a whatsapp number profile picture.
**端点**: `GET /wspic/b64`
**参数**:
- `phone` (number) *必需*: Enter phone number with country code, without special characters.
---
### `fetch_osint_info`
This endpoint adeptly determines whether a given number is registered on WhatsApp. In the affirmative case, it provides insights into the visibility of the profile picture, and if accessible, furnishes the public URL of the image in the response.
**端点**: `GET /wspic/dck`
**参数**:
- `phone` (number) *必需*: The whatsapp number must be written as countrycode and number, no special characters.
---
## Tech Stack
- **Transport Protocol**: stdio
- **HTTP Client**: httpx
## License
MIT License - See [LICENSE](./LICENSE) file for details.
## Development
This server is generated by [API-to-MCP](https://github.com/BACH-AI-Tools/api-to-mcp) tool.
Version: 1.0.0
