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: '已认证' }
   

提供されるツール

連絡先管理

• searchContacts()：名前または電話番号で連絡先を検索します。
• getContactById()：指定された連絡先の詳細情報を取得します。

チャット管理

• listChats()：すべての利用可能なチャットとそのメタデータをリストします。
• getChat()：特定のチャットの詳細情報を取得します。
• getDirectChatByContact()：特定の連絡先との1対1のチャットを検索します。

メッセージ管理

• 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でサポートを求めてください。