Wweb MCP

🚀 WhatsApp Web ロボットフレームワーク

WhatsApp Web ロボットフレームワークは、WhatsApp アカウントを制御してメッセージの送受信を行うための強力なツールです。このフレームワークは whatsapp-web.js に基づいており、ブラウザ版の WhatsApp を介して接続します。

🚀 クイックスタート

📦 インストール

依存関係のインストール

このプロジェクトでは、npm パッケージマネージャを使用して依存関係の管理と実行環境の設定を行っています。すべての依存関係をインストールするには、以下のコマンドを実行します。

npm install

Docker を使用する場合

簡単なデプロイを目的として、このプロジェクトには Docker イメージが用意されています。イメージを取得して起動するには、以下のコマンドを実行します。

docker pull liuhuanjin0927/whatsapp-web-mcp:latest
docker run -it --rm liuhuanjin0927/whatsapp-web-mcp

クイックスタートのコード例

main.ts ファイルには、簡単な実行例が記載されています。

import { WhatsApp } from 'whatsapp-web.js';
import * as WAProto from '@whatsprotypes/core';

async function run() {
    const WA = new WhatsApp({
        puppeteer: {
            executablePath: process.env.CHROME_PATH || undefined,
            args: ['--no-sandbox']
        },
        logLevel: 'info'
    });

    await WA.start();
    console.log('WhatsApp 已启动');
}

run().catch(console.error);

✨ 主な機能

• メッセージ送受信：テキスト、画像などのメッセージの送受信をサポートします。
• メディア処理：画像、音声、ファイルなどのメディアコンテンツの送信とダウンロードが可能です。
• グループ管理：グループチャットの作成、参加、退出機能を提供します。
• 連絡先管理：連絡先の追加、削除、検索をサポートします。
• ログシステム：Winston ベースの強力なログ記録機能が組み込まれています。

📚 ドキュメント

プロジェクトのビルド

ソースコードからプロジェクトをビルドするには、以下のコマンドを実行します。

npm run build

テスト

Jest を使用して単体テストを実行します。

# すべてのテストを実行
npm test

# 監視モードでテストを実行
npm run test:watch

# カバレッジレポートを生成
npm run test:coverage

コードのフォーマットと品質管理

ESLint と Prettier を使用してコード規約を維持します。

# 検査を実行
npm run lint

# 問題を自動修正
npm run lint:fix

# コードをフォーマット
npm run format

🔧 技術詳細

トラブルシューティング

統合に関する問題

• Claude Desktop 統合の制限：Claude は複数のプロセスを起動するため、コマンドラインモードで直接 wweb-mcp を実行することはできません。この問題を解決するために、アプリケーションを MCP モードと API モードに分割し、Claude との互換性を実現しています。

将来の計画

• メディアサポートの拡張：ビデオ、音声、ファイルの送信をサポートする予定です。
• テンプレートメッセージ：一般的なシナリオのメッセージテンプレートを提供します。
• 高度なグループ機能：強化されたグループ管理機能を追加します。
• パフォーマンス最適化：高負荷時のロボットのパフォーマンスを向上させます。

🤝 貢献ガイド

コードの貢献方法

1. プロジェクトリポジトリを Fork します。
2. 新しいブランチを作成します。
3. コードの変更をコミットします。
4. Pull Request を送信します。

開発時の注意事項

• プロジェクトのコード規約とスタイルに従ってください。
• 新しい機能が単体テストに合格することを確認してください。
• 詳細なドキュメントを提供してください。

📝 ログ記録

ログレベル

このプロジェクトは以下のログレベルをサポートしています。

• debug：デバッグ情報
• info：一般情報
• warning：警告情報
• error：エラー情報
• critical：重大なエラー
• fatal：致命的なエラー

デフォルトのログレベルは info です。

🛠️ トラブルシューティングガイド

一般的な問題と解決策

1. WhatsApp アカウントに接続できない場合
   • ブラウザで対象のアカウントにログインしていることを確認してください。
   • ネットワーク接続の状態を確認してください。
   • コンソール出力のエラーメッセージを確認してください。
2. Docker デプロイが失敗した場合
   • Docker サービスが実行中であることを確認してください。
   • イメージの取得ログを確認してください。
   • ポートマッピングと権限設定を確認してください。

👥 貢献者リスト

• 開発者：[あなたの名前]
• メンテナ：[メンテナの名前]

📄 ライセンス

このプロジェクトは MIT License に従っています。

WhatsApp Web ロボットフレームワークをご利用いただき、ありがとうございます！何か問題や提案があれば、いつでもお問い合わせください。