email-mcp-server by ishibashm - MCP Server

Email MCP Server (メール MCP サーバー)

このプロジェクトは、メールサービスと連携するための MCP (Model Context Protocol) サーバーです。SMTP および IMAP プロトコルを使用して、メールの送受信を可能にします。

✨ 機能

メール送信 (SMTP): 設定された SMTP アカウントを使用してメールを送信します。
最近のメール取得 (IMAP): INBOX から最近のメールリストを取得します。
メール内容読み取り (IMAP): 指定されたメール ID (通常は UID) を使用して、特定のメールの内容を読み取ります。
メール検索 (IMAP): IMAP の検索条件に基づいてメールを検索します。

🚀 セットアップ

リポジトリのクローン:

git clone https://github.com/ishibashm/email-mcp-server.git
cd email-mcp-server

依存関係のインストール:
```
npm install
```
環境変数の設定: プロジェクトルートに .env ファイルを作成し、メールアカウントの認証情報などを設定します。設定項目については、.env.example ファイル (もし存在すれば) を参照してください。最低限、以下の情報が必要です。
```
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=your_email@example.com
SMTP_PASS=your_password

IMAP_HOST=imap.example.com
IMAP_PORT=993
IMAP_USER=your_email@example.com
IMAP_PASS=your_password
IMAP_TLS=true # または false
```
プロジェクトのビルド:
```
npm run build
```
サーバーの起動:
```
npm start
```
または、開発モードで起動する場合:
```
npm run dev
```

🐳 Docker を使用したセットアップ

Docker を使用して、より簡単に環境を構築し、サーバーを実行することも可能です。

Docker および Docker Compose のインストール: まだインストールしていない場合は、お使いの OS に合わせて Docker Desktop (Docker Compose を含む) をインストールしてください。
- Docker Desktop 公式サイト
環境変数の設定: ローカルでのセットアップと同様に、プロジェクトルートに .env ファイルを作成し、メールアカウントの認証情報を設定します。このファイルは Docker コンテナ内から参照されます。
```
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=your_email@example.com
SMTP_PASS=your_password

IMAP_HOST=imap.example.com
IMAP_PORT=993
IMAP_USER=your_email@example.com
IMAP_PASS=your_password
IMAP_TLS=true # または false
```
注意: .env ファイルは .gitignore に含まれているため、Git リポジトリにはコミットされません。
Docker イメージのビルドとコンテナの起動: プロジェクトのルートディレクトリで以下のコマンドを実行します。
```
docker-compose up --build
```
これにより、Dockerfile に基づいて Docker イメージがビルドされ、docker-compose.yml の設定に従ってコンテナが起動します。初回起動時や Dockerfile に変更があった場合は --build オプションが必要です。2回目以降は docker-compose up だけで起動できます。
コンテナの停止: コンテナを停止するには、ターミナルで Ctrl + C を押します。バックグラウンドで起動している場合は、以下のコマンドで停止できます。
```
docker-compose down
```

🛠️ 使い方

このサーバーは、MCP クライアントがメールアカウントと対話するためのツールを公開します。クライアントは、このサーバーに接続し、提供されるツール (例: send_email, get_recent_emails) を利用してメール操作を実行できます。

サーバーへの接続方法やツールの具体的な使用方法については、MCP のドキュメントおよびこのサーバーが提供するツールスキーマを参照してください。

🤝 コントリビューション

バグ報告や機能提案は、GitHub Issues までお気軽にどうぞ。プルリクエストも歓迎します。

📄 ライセンス

(ライセンス情報を追記する場合はここに記述)