gmail-mcp

gmail-mcp

0
communicationcalendar_management

The Gmail MCP Server integrates Gmail and Google Calendar with Claude Desktop to provide intelligent and context-aware email interactions. It offers features like deep email analysis, context-aware responses, and advanced search capabilities.

Gmail MCP Server

smithery badge

A Model Context Protocol (MCP) server for Gmail & Google Calendar integration with Claude Desktop, enabling intelligent, context-aware interactions with your email.

🌟 Features

  • Deep Email Analysis: Provides comprehensive context from entire conversation threads
  • Context-Aware Responses: Generates responses considering full communication history
  • Intelligent Action Suggestions: Analyzes email content for calendar events, tasks, and follow-ups
  • Calendar Integration: Detects events in emails and creates calendar entries with natural language support
  • Advanced Search: Searches across entire email history with semantic understanding
  • Personalization: Adapts to your communication style with specific contacts

🚀 Getting Started

Prerequisites

  • Python 3.10+
  • A Google Cloud Platform account with Gmail API and Google Calendar API (optional) enabled
  • OAuth 2.0 credentials for the Gmail API and Google Calendar API (optional)
  • Claude Desktop with MCP support (currently only LLM interface to support MCP)

Installation

Installing via Smithery

To install Gmail Integration Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @bastienchabal/gmail-mcp --client claude
Installing Manually

  1. Clone this repository:

    git clone https://github.com/bastienchabal/gmail-mcp.git
cd gmail-mcp

  2. Set up a virtual environment using uv:

    pip install uv
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

  3. Install dependencies:

    uv pip install -e .

⚙️ Configuration

Step 1: Authenticate with Google

  1. Go to the Google Cloud Console
  2. Create a new project or select an existing one
  3. Enable Google APIs:
  4. Configure the OAuth consent screen:
    • Select "External" user type
    • Add your email as a test user
    • Add all the scopes of Gmail and Calendar
  5. Create OAuth 2.0 credentials:
    • Choose "Desktop app" as the application type
    • Download the JSON credentials file and copy the Client ID and Client Secret

Step 2: Configure Claude Desktop

  1. Create or edit the claude_desktop_config.json file in /Users/<username>/Library/Application Support/Claude
  2. Add the following configuration, replacing the placeholders with your actual values:
{
  "mcpServers": {
    "gmail-mcp": {
      "command": "/<absolute-path>/gmail-mcp/.venv/bin/mcp",
      "args": [
        "run",
        "/<absolute-path>/gmail-mcp/gmail_mcp/main.py:mcp"
      ],
      "cwd": "/<absolute-path>/gmail-mcp",
      "env": {
        "PYTHONPATH": "/<absolute-path>/gmail-mcp",
        "CONFIG_FILE_PATH": "/<absolute-path>/gmail-mcp/config.yaml",
        "GOOGLE_CLIENT_ID": "<your-client-id>",
        "GOOGLE_CLIENT_SECRET": "<your-client-secret>",
        "TOKEN_ENCRYPTION_KEY": "<generate-a-random-key>"
      }
    }
  }
}

Notes:

  • Replace <absolute-path> with the actual path to your gmail-mcp directory
  • Replace <your-client-id> and <your-client-secret> with your Google OAuth credentials (previously generated in the json file)
  • Optional : Generate a random encryption key with: python -c "import os; from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"

The configuration is designed to keep sensitive data (client ID, client secret, and encryption key) in the Claude Desktop configuration file, while non-sensitive settings are stored in the config.yaml file included in the repository.

Step 3: Use Claude Desktop

  1. Open Claude Desktop
  2. Type a prompt like: "Please retrieve my last email"
  3. Claude should automatically connect to the MCP server and ask you to authenticate to your Gmail account (creating the file tokens.json)

❓ Troubleshooting

Important Note on MCP

If Claude Desktop doesn't connect automatically (i.e. you do not see the tool icon underneath the prompt input), you can try:

  • Restarting Claude Desktop
  • Asking Claude to "Use the Gmail MCP server"
  • Login to Gmail manually using one of these methods:

Important Note on Authentication

  1. Authentication Problems:

    • Run python debug/auth_test.py to test the authentication process with detailed feedback
    • Check that the token file exists at the project root
    • Verify that your Google Cloud Console project has the correct redirect URI configured
    • Make sure all required scopes are added to your OAuth consent screen
    • If you see "Scope has changed" errors, ensure that the openid scope is included in your OAuth consent screen
    • If you see "redirect_uri_mismatch" errors, add the exact URI shown in the error message to your authorized redirect URIs in Google Cloud Console
    • If the callback page doesn't load or process properly, check if port 8000 is already in use by another application

  2. Calendar API Issues:

    • Make sure you've enabled the Calendar API in Google Cloud Console
    • Check that you've granted all the necessary scopes during authentication
    • Run python debug/reauth_calendar.py to re-authenticate with Calendar API scopes
    • Verify that CALENDAR_API_ENABLED is set to true in your environment variables

Important Note on Calendar Integration

Calendar integration can be turned off in the configuration file. If you've previously authenticated with the Gmail MCP server and are now enabling Calendar integration, you'll need to re-authenticate to grant the additional Calendar API scopes. You can do this by:

  1. Deleting the existing tokens.json file (if present, either at projet root or in ~/Users/<username/>gmail_mcp_tokens/tokens.json)
  2. Restarting the MCP server
  3. Following the authentication process again

👤 Usage

The Gmail MCP provides powerful, context-aware tools for managing your emails and calendar:

Email Management

  • Email Overview: Get a comprehensive view of your inbox with counts and recent emails
  • Advanced Search: Use Gmail's powerful search syntax to find specific emails
  • Detailed Email Analysis: View emails with full context, including thread history and sender information

Context-Aware Email Replies

  • Intelligent Reply Preparation: Analyze the full context of an email thread before replying
  • Communication Pattern Analysis: Understand your communication history with the sender
  • Personalized Drafting: Create draft replies that match your communication style with specific contacts
  • Entity Recognition: Identify important dates, times, action items, and other entities in emails
  • Related Email Context: Consider other relevant emails when crafting replies

Calendar Integration

  • Event Creation: Create calendar events with natural language time descriptions
  • Event Detection: Automatically detect potential events mentioned in emails
  • Calendar Management: View, search, and manage your upcoming calendar events
  • Smart Scheduling: Schedule meetings with appropriate context from email conversations

Example Requests

You can ask Claude to use these capabilities with natural language requests like:

  • "Show me an overview of my inbox"
  • "Find all unread emails from my boss about the quarterly report"
  • "Help me reply to the last email from Sarah about the project deadline"
  • "Create a calendar event for the team meeting mentioned in John's email"
  • "What meetings do I have scheduled for next week?"
  • "Analyze this email thread and help me understand the key points before I reply"
  • "Draft a response to this email considering my previous communications with this person"

Available Resources

The MCP provides rich contextual resources that Claude can access:

  • Email Context: Detailed information about specific emails
  • Thread Context: Full conversation history for email threads
  • Sender Context: Information about your relationship and communication history with senders
  • Authentication Status: Current authentication state with Google
  • Gmail Status: Overview of your Gmail account
  • Server Information: Details about the MCP server configuration

Available Guides

The MCP includes several guides to help you get the most out of its capabilities:

  • Quick Start Guide: Basic instructions for getting started
  • Authentication Guide: Help with the authentication process
  • Search Guide: Advanced Gmail search syntax reference
  • Reply Guide: Best practices for context-aware email replies
  • Debug Guide: Troubleshooting common issues

☑️ This MCP is configured so Claude will always ask you for confirmation before doing any important action, such as sending an email or creating a meeting.

⚠ Beta Notice

This MCP is a WIP and is currently in beta.

📝 License

This project is licensed under the MIT License.

💡 Acknowledgements

  • This project uses the Model Context Protocol (MCP) developed by Anthropic
  • Gmail API access is provided by Google's API services