MCP Gmail Server

by jeremyjordan

10 514 downloads Not rated yet

About

A Model Context Protocol (MCP) server that provides Gmail access for LLMs, powered by the MCP Python SDK.

Explore

- Expose Gmail messages as MCP resources
- Provide tools for composing, sending, and managing emails
- OAuth 2.0 authentication with Google's Gmail API

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name MCP Gmail Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

- Python 3.10+
- Gmail account with API access
- uv for Python package management (recommended)

Install project dependencies (uv automatically creates and manages a virtual environment)

uv sync

There's unfortunately a lot of steps required to use the Gmail API. I've attempted to capture all of the required steps (as of March 28, 2025) but things may change.

1. Create a Google Cloud Project
- Go to Google Cloud Console
- Click on the project dropdown at the top of the page
- Click "New Project"
- Enter a project name (e.g., "MCP Gmail Integration")
- Click "Create"
- Wait for the project to be created and select it from the dropdown

2. Enable the Gmail API
- In your Google Cloud project, go to the navigation menu (≡)
- Select "APIs & Services" > "Library"
- Search for "Gmail API"
- Click on the Gmail API card
- Click "Enable"

3. Configure OAuth Consent Screen
- Go to "APIs & Services" > "OAuth consent screen"
- You will likely see something like "Google Auth Platform not configured yet"
- Click on "Get started"
- Fill in the required application information:
- App name: "MCP Gmail Integration"
- User support email: Your email address
- Fill in the required audience information:
- Choose "External" user type (unless you have a Google Workspace organization)
- Fill in the required contact information:
- Your email address
- Click "Save and Continue"
- Click "Create"

4. Create OAuth Credentials
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth client ID"
- Choose "Desktop app" as the application type
- Enter a name (e.g., "MCP Gmail Desktop Client")
- Click "Create"
- Click "Download JSON" for the credentials you just created
- Save the file as credentials.json in your project root directory

5. Add scopes
- Go to "APIs & Services" > "OAuth consent screen"
- Go to the "Data Access" tab
- Click "Add or remove scopes"
- Search for the Gmail API
- Select the scope for .../auth/gmail.modify which grants permission to "Read, compose, and send emails from your Gmail account"
- Click update
- Click save

Verify that you've set up your OAuth configuration correctly by running a simple test script.

uv run python scripts/test_gmail_setup.py

You should be able to see usage metrics at https://console.cloud.google.com/apis/api/gmail.googleapis.com/metrics

You can configure the server using environment variables:

- MCP_GMAIL_CREDENTIALS_PATH: Path to the OAuth credentials JSON file (default: "credentials.json")
- MCP_GMAIL_TOKEN_PATH: Path to store the OAuth token (default: "token.json")
- MCP_GMAIL_MAX_RESULTS: Default maximum results for search queries (default: 10)

compose_email

Create a new email draft

send_email

Send an email

search_emails

Search for emails with specific filters (from, to, subject, dates, etc.)

query_emails

Search for emails using raw Gmail query syntax

get_emails

Retrieve multiple email messages by their IDs

list_available_labels

Get all available Gmail labels

mark_message_read

Mark a message as read

add_label_to_message

Add a label to a message

remove_label_from_message

Remove a label from a message

- compose_email - Create a new email draft
- send_email - Send an email
- search_emails - Search for emails with specific filters (from, to, subject, dates, etc.)
- query_emails - Search for emails using raw Gmail query syntax
- get_emails - Retrieve multiple email messages by their IDs
- list_available_labels - Get all available Gmail labels
- mark_message_read - Mark a message as read
- add_label_to_message - Add a label to a message
- remove_label_from_message - Remove a label from a message

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "mcp gmail server": {
            "mcp-gmail": {
                "command": "uv",
                "args": [
                    "sync"
                ]
            }
        }
    }
}

McpServers

{
    "mcp-gmail": {
        "command": "uv",
        "args": [
            "sync"
        ]
    }
}

A Model Context Protocol (MCP) server that provides Gmail access for LLMs, powered by the MCP Python SDK.

Features

- Expose Gmail messages as MCP resources
- Provide tools for composing, sending, and managing emails
- OAuth 2.0 authentication with Google's Gmail API

Prerequisites

- Python 3.10+
- Gmail account with API access
- uv for Python package management (recommended)

Setup

1. Install dependencies

Install project dependencies (uv automatically creates and manages a virtual environment)

uv sync

2. Configure Gmail OAuth credentials

There's unfortunately a lot of steps required to use the Gmail API. I've attempted to capture all of the required steps (as of March 28, 2025) but things may change.

Google Cloud Setup

1. Create a Google Cloud Project
- Go to Google Cloud Console
- Click on the project dropdown at the top of the page
- Click "New Project"
- Enter a project name (e.g., "MCP Gmail Integration")
- Click "Create"
- Wait for the project to be created and select it from the dropdown

2. Enable the Gmail API
- In your Google Cloud project, go to the navigation menu (≡)
- Select "APIs & Services" > "Library"
- Search for "Gmail API"
- Click on the Gmail API card
- Click "Enable"

3. Configure OAuth Consent Screen
- Go to "APIs & Services" > "OAuth consent screen"
- You will likely see something like "Google Auth Platform not configured yet"
- Click on "Get started"
- Fill in the required application information:
- App name: "MCP Gmail Integration"
- User support email: Your email address
- Fill in the required audience information:
- Choose "External" user type (unless you have a Google Workspace organization)
- Fill in the required contact information:
- Your email address
- Click "Save and Continue"
- Click "Create"

4. Create OAuth Credentials
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth client ID"
- Choose "Desktop app" as the application type
- Enter a name (e.g., "MCP Gmail Desktop Client")
- Click "Create"
- Click "Download JSON" for the credentials you just created
- Save the file as credentials.json in your project root directory

5. Add scopes
- Go to "APIs & Services" > "OAuth consent screen"
- Go to the "Data Access" tab
- Click "Add or remove scopes"
- Search for the Gmail API
- Select the scope for .../auth/gmail.modify which grants permission to "Read, compose, and send emails from your Gmail account"
- Click update
- Click save

Verify that you've set up your OAuth configuration correctly by running a simple test script.

uv run python scripts/test_gmail_setup.py

You should be able to see usage metrics at https://console.cloud.google.com/apis/api/gmail.googleapis.com/metrics

3. Run the server

Development mode:

uv run mcp dev mcp_gmail/server.py

This will spin up an MCP Inspector application that you can use to interact with the MCP server.

Or install for use with Claude Desktop:

uv run mcp install \
--with-editable .
--name gmail \
--env-var MCP_GMAIL_CREDENTIALS_PATH=$(pwd)/credentials.json \
--env-var MCP_GMAIL_TOKEN_PATH=$(pwd)/token.json \
mcp_gmail/server.py

> [!NOTE]
> If you encounter an error like Error: spawn uv ENOENT when spinning up Claude Desktop and initializing the MCP server, you may need to update your claude_desktop_config.json to provide the absolute path to uv. Go to Claude Desktop -> Settings -> Developer -> Edit Config.
>
>

> {
> "mcpServers": {
> "gmail": {
> "command": "~/.local/bin/uv",
> }
> }
> }
>

Development

Linting and Testing

Run linting and formatting:
```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.