Gmail

🚀 Gmail MCP 使用説明

この npm パッケージは、モデルコンテキストプロトコル（MCP）を実装しており、Gmail API とのインタラクションに使用されます。標準化されたインターフェースを提供することで、電子メールの管理、送信、および検索を容易にします。

🚀 クイックスタート

1. 設定ファイルの初期化

オペレーティングシステムに応じて、設定ファイルを以下のディレクトリに配置します。

• Mac/Linux：~/.config/gmail-mcp/config.json
• Windows：%APPDATA%/gmail-mcp/config.json

設定ファイルの例を以下に示します。

{
  "clientId": "your_client_id",
  "clientSecret": "your_client_secret",
  "refreshToken": "your_refresh_token"
}

2. Gmail クライアントの初期化

コード内でクライアントを初期化する際には、設定ファイルのパスとデフォルトの受信トレイを指定する必要があります。

import { GmailClient } from '@shinzolabs/gmail-mcp';

// 開発環境ではデフォルトで development モードを使用して Gmail クライアントを初期化
const gmail = new GmailClient({
  configFile: process.env.NODE_ENV === 'development' ? '~/.config/gmail-mcp/config.json' : undefined,
  defaultInbox: 'INBOX'
});

// Gmail サービスに接続
await gmail.connect();

✨ 主な機能

このパッケージは、Gmail API とのインタラクションを容易にするための様々な機能を提供します。主な機能は以下の通りです。

• ユーザー管理：ユーザープロファイルの取得やメール通知の管理が可能です。
• メッセージ管理：メッセージの一覧表示、取得、送信、削除などの操作ができます。
• ラベル管理：ラベルの一覧表示、作成、更新、削除が可能です。
• スレッド管理：スレッドの一覧表示、取得、操作ができます。
• 受信トレイ管理：受信トレイの一覧表示、選択、作成、削除が可能です。

📦 インストール

npm または yarn を使用してこのパッケージをインストールします。

npm install @shinzolabs/gmail-mcp
# または
yarn add @shinzolabs/gmail-mcp

📚 ドキュメント

サポートされる API エンドポイント

ユーザー管理

• get_profile：現在のユーザーの Gmail プロファイル情報を取得します。
• stop_mail_watch：メールのプッシュ通知の受信を停止します。
• watch_mailbox：メールボックスの変更に対するプッシュ通知機能を有効にします。

メッセージ管理

メッセージ操作

• list_messages：指定された条件に一致するメッセージの一覧を表示します。
• get_message：指定されたメッセージの詳細内容を取得します。
• get_attachment：特定のメッセージ内の添付ファイルをダウンロードします。
• modify_message：メッセージのラベル情報を変更します。
• send_message：指定された宛先に電子メールを送信します。
• delete_message：メッセージを永久に削除します。
• trash_message：メッセージをゴミ箱に移動します。
• untrash_message：ゴミ箱からメッセージを取り出します。
• batch_modify_messages：複数のメッセージのラベルを一括で変更します。
• batch_delete_messages：複数のメッセージを一括で削除します。

ラベル管理

• list_labels：すべての既存のラベルを一覧表示します。
• get_label：特定のラベルの詳細情報を取得します。
• create_label：新しいラベルを作成します。
• update_label：ラベルの設定情報を更新します。
• patch_label：ラベル情報の一部を更新します（指定されたフィールドのみ変更）。
• delete_label：ラベルを削除します。

スレッド管理

• list_threads：すべてのメールスレッドを一覧表示します。
• get_thread：特定のスレッドの詳細内容を取得します。
• modify_thread：スレッドの関連属性を変更します。
• trash_thread：スレッド全体をゴミ箱に移動します。
• untrash_thread：ゴミ箱からスレッド全体を復元します。

受信トレイ管理

• list_inboxes：利用可能なすべての受信トレイの一覧を取得します。
• get_inbox：指定された受信トレイの詳細情報を取得します。
• select_inbox：指定された受信トレイに切り替えて操作を行います。
• create_inbox：新しい受信トレイを作成します（管理者のみ利用可能）。
• delete_inbox：指定された受信トレイを削除します（管理者のみ利用可能）。

🔧 技術詳細

環境変数の設定

実行時には、Gmail の認証情報を環境変数を通じて提供する必要があります。具体的には、以下の変数を設定する必要があります。

• GMAIL_CLIENT_ID：クライアント ID
• GMAIL_CLIENT_SECRET：クライアントシークレット
• GMAIL_REFRESH_TOKEN：リフレッシュトークン

開発とテスト

開発およびテスト環境では、実際の本番アカウントを使用しないでください。テスト用の専用 Gmail アカウントを作成することをお勧めします。

📄 問題フィードバック

何か問題が発生した場合や追加のサポートが必要な場合は、以下の方法で私たちのチームに連絡してください。

• メール：support@shinzolabs.com
• GitHub リポジトリ：プロジェクトリポジトリへ移動

Gmail MCP をご利用いただき、ありがとうございます！