# Whatsapp Osint MCP Server
[English](./README_EN.md) | [简体中文](./README.md) | 繁體中文
用於存取 Whatsapp Osint API 的 MCP 伺服器。
## 🚀 使用 EMCP 平台快速體驗
**[EMCP](https://sit-emcp.kaleido.guru)** 是一個強大的 MCP 伺服器管理平台，讓您無需手動配置即可快速使用各種 MCP 伺服器！
### 快速開始：
1. 🌐 造訪 **[EMCP 平台](https://sit-emcp.kaleido.guru)**
2. 📝 註冊並登入帳號
3. 🎯 進入 **MCP 廣場**，瀏覽所有可用的 MCP 伺服器
4. 🔍 搜尋或找到本伺服器（`bach-whatsapp_osint`）
5. 🎉 點擊 **「安裝 MCP」** 按鈕
6. ✅ 完成！即可在您的應用中使用
### EMCP 平台優勢：
- ✨ **零配置**：無需手動編輯配置檔案
- 🎨 **視覺化管理**：圖形介面輕鬆管理所有 MCP 伺服器
- 🔐 **安全可靠**：統一管理 API 金鑰和認證資訊
- 🚀 **一鍵安裝**：MCP 廣場提供豐富的伺服器選擇
- 📊 **使用統計**：即時查看服務調用情況
立即造訪 **[EMCP 平台](https://sit-emcp.kaleido.guru)** 開始您的 MCP 之旅！
---
## 簡介
這是一個 MCP 伺服器，用於存取 Whatsapp Osint API。
- **PyPI 套件名**: `bach-whatsapp_osint`
- **版本**: 1.0.0
- **傳輸協定**: 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
```
## 配置
### API 認證
此 API 需要認證。請設定環境變數:
```bash
export API_KEY="your_api_key_here"
```
### 環境變數
| 變數名 | 說明 | 必需 |
|--------|------|------|
| `API_KEY` | API 金鑰 | 是 |
| `PORT` | 不適用 | 否 |
| `HOST` | 不適用 | 否 |
### 在 Cursor 中使用
編輯 Cursor MCP 配置檔案 `~/.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"
}
}
}
}
```
### 在 Claude Desktop 中使用
編輯 Claude Desktop 配置檔案 `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.
---
## 技術棧
- **傳輸協定**: stdio
- **HTTP 客戶端**: httpx
## 授權
MIT License - 詳見 [LICENSE](./LICENSE) 檔案。
## 開發
此伺服器由 [API-to-MCP](https://github.com/BACH-AI-Tools/api-to-mcp) 工具生成。
版本: 1.0.0
