MCP Whatsapp Web

🚀 使用MCP WhatsApp接口

MCP WhatsApp是一個用於與WhatsApp Web交互的最小化控制檯接口。它讓用戶能通過命令行或集成到其他應用程序中收發消息，還提供了一系列管理和操作WhatsApp賬戶的工具。

🚀 快速開始

安裝依賴

在開始使用之前，請確保安裝了以下依賴項：

npm install puppeteer whatsapp-mcp --save

項目初始化

1. 初始化一個新的項目，並將以下內容添加到package.json中：

   {
     "name": "whatsapp-bot",
     "version": "1.0.0",
     "scripts": {
       "start": "mcp whatsapp:start"
     },
     "dependencies": {
       "whatsapp-mcp": "^3.0.0",
       "puppeteer": "^20.14.3"
     }
   }
   

2. 創建一個新的啟動腳本src/index.ts：

   import { start } from 'whatsapp-mcp';
   
   start();
   

3. 啟動項目：

   npm run start
   

✨ 主要特性

1. CPU佔用率最低

使用Puppeteer的無頭模式運行，以最小化資源消耗。

2. 跨平臺兼容性

支持Windows、macOS和Linux系統。

3. 高可用性

內置斷線重連機制，確保長時間穩定運行。

📦 安裝指南

認證流程

1. 初始化一個新的whatsapp-mcp實例：

   import { createClient } from 'whatsapp-mcp';
   
   const client = await createClient({
     session: './session',
     headless: true,
     chromiumArgs: ['--no-sandbox', '--disable-gpu']
   });
   

2. 發送認證請求：

   await client.auth.sendQRCode();
   

3. 處理用戶輸入的認證令牌：

   await client.auth.handleAuthResponse('your_auth_token_here');
   

4. 確認認證狀態：

   console.log(await client.auth.getStatus());
   // 輸出: { isAuth: true, message: '已認證' }
   

💻 使用示例

基礎用法

// 初始化項目
import { start } from 'whatsapp-mcp';
start();

// 初始化客戶端
import { createClient } from 'whatsapp-mcp';
const client = await createClient({
  session: './session',
  headless: true,
  chromiumArgs: ['--no-sandbox', '--disable-gpu']
});

高級用法

// 發送認證請求
await client.auth.sendQRCode();

// 處理認證令牌
await client.auth.handleAuthResponse('your_auth_token_here');

// 確認認證狀態
console.log(await client.auth.getStatus());

📚 詳細文檔

提供的工具

聯繫人管理

• searchContacts()：通過姓名或電話號碼搜索聯繫人。
• getContactById()：獲取指定聯繫人的詳細信息。

對話管理

• listChats()：列出所有可用對話及其元數據。
• getChat()：獲取特定對話的詳細信息。
• getDirectChatByContact()：查找與特定聯繫人的一對一聊天。

消息管理

• listMessages()：按條件過濾檢索消息。
• sendMessage()：向指定目標發送文本或媒體消息。
• listenForNewMessage()：訂閱即時消息通知。

媒體處理

支持發送和接收圖片、視頻、文件等多媒體內容。

瀏覽器進程管理

無頭模式運行

通過配置Puppeteer的無頭參數，可以在不顯示瀏覽器窗口的情況下運行：

await createClient({
   headless: true,
   ...
});

自動化資源清理

MCP WhatsApp在初始化時會自動優化內存使用，並在進程終止時清理臨時文件。

🔧 技術細節

• 項目結構：默認情況下，會話數據和緩存文件存儲在./session目錄中。
• 錯誤處理：內置了詳細的錯誤捕捉機制，幫助開發者快速定位問題。
• 日誌記錄：支持輸出調試信息，並且允許配置不同的日誌級別。

🛠️ 故障排除

1. 啟動時出錯

檢查是否有有效的WhatsApp賬戶登錄，或者嘗試重新初始化會話文件夾：

rm -rf ./session && npm run start

2. 網絡連接問題

確保網絡穩定，並檢查防火牆設置是否阻止了必要的端口。

📄 許可證

MCP WhatsApp是在MIT License許可證下發布的。詳細許可信息請查閱項目倉庫或LICENSE文件。

如需進一步幫助，請參考官方文檔或通過GitHub Issues尋求支持。