Quantum 369 Gmail MCP Server

🚀 Gmail MCP Server

A powerful and flexible Gmail integration server built on the MCP (Message Control Protocol) framework. This server provides a robust interface to interact with the Gmail API, supporting email reading, sending, and management.

🚀 Quick Start

A powerful and flexible Gmail integration server, built on the MCP (Message Control Protocol) framework. This server offers a robust interface to interact with the Gmail API, enabling email reading, sending, and management.

✨ Features

• Read emails from multiple Gmail accounts.
• Send emails with attachments.
• Search for emails with advanced search options.
• Download email attachments.
• Manage email conversations and threads.
• Monitor emails in real-time.
• Support multiple Gmail accounts.

📦 Prerequisites

Before running the Gmail MCP Server, ensure the following conditions are met:

1. Python 3.12 or higher.
2. A Google Cloud project with the Gmail API enabled.
3. OAuth 2.0 client ID credentials.
4. Required Python packages (specified in pyproject.toml).

📦 Installation

Install via Smithery

Use Smithery to automatically install the Gmail integration server:

npx -y @smithery/cli install @Quantum-369/Gmail-mcp-server --client claude

Manual Installation

1. Clone the repository:

git clone <your-repository-url>
cd gmail-mcp-server

2. Create and activate a virtual environment:

python -m venv venv
# For Windows
venv\Scripts\activate
# For Unix/MacOS
source venv/bin/activate

3. Install dependencies:

pip install .

📚 Configuration of Google Cloud Project

1. Visit Google Cloud Console.
2. Create a new project or select an existing one.
3. Enable the Gmail API for the project.
4. Create OAuth 2.0 credentials:
   • Go to "APIs & Services" > "Credentials".
   • Click "Create Credentials" > "OAuth client ID".
   • Select "Desktop app" as the application type.
   • Download the client configuration file.
5. Rename the downloaded file to client_secret.json and place it in the project root directory.

📚 Configuration

1. Set the email identifier in gmail_token_creator.py:

email_identifier = 'your.email@gmail.com'  # Modify as needed

2. Run the token creation tool to authenticate your Gmail account:

python gmail_token_creator.py

3. Repeat the above steps for each Gmail account you want to integrate.

🔧 Server Structure

• gmail_server.py: Main MCP server implementation.
• gmail_api.py: Functions for interacting with the Gmail API.
• google_apis.py: Google API authentication tools.
• Support files:
  • read_emails.py: Email reading functionality.
  • search_emails.py: Email search functionality.
  • send_emails.py: Email sending functionality.

💻 Usage Examples

Start the Server

python gmail_server.py

Available Tools

Basic Usage

# Send an email
await send_gmail(
    email_identifier="your.email@gmail.com",
    to="recipient@example.com",
    subject="Test Subject",
    body="Email body content",
    attachment_paths=["path/to/attachment"]
)

# Search for emails
async def process_email(email):
    # Process the found emails
    pass

await search_emails(
    email_identifier="your.email@gmail.com",
    query="subject:important",
    callback=process_email
)

# Download attachments
async def download_attachment(attachment):
    # Process the downloaded attachments
    pass

await get_attachments(
    email_identifier="your.email@gmail.com",
    message_id="message-id-12345",
    attachments_callback=download_attachment
)

⚠️ Important Note

• Ensure the security of the client_secret.json file to avoid leakage.
• Use environment variables to store sensitive information (e.g., email passwords).
• Regularly update OAuth tokens to enhance security.

📚 Other Resources

• Gmail API Documentation
• Python Gmail Sample Code

By following the above steps, you can easily set up and use the Gmail MCP Server to manage your emails and attachments.