Gmail MCP Java Server

A Gmail MCP server project based on Spring Boot, providing tools for interacting with Gmail and a test client.

Developer tools Communication tools #Gmail tools #Email management #Spring Boot .Java

rating : 2 points

downloads : 6.4K

update time : 2025-04-28

Open Site

What is Gmail MCP Server?

Gmail MCP Server is a background service that allows you to manage your Gmail accounts through simple commands. It can help you automatically process emails, such as automatically marking emails as read and managing spam emails.

How to use Gmail MCP Server?

You need to set up Google API permissions first and then run the server. After that, you can manage emails through client tools or by directly calling the API.

Use cases

Suitable for users who need to process Gmail emails in batches, or individuals and small businesses who want to automate email management.

Main features

Email management

Basic management functions such as moving emails to the trash and marking them as read/unread.

Email sending

Supports sending new emails through the API.

Get unread emails

Can get a list of all unread emails.

Advantages

Automated email management saves time

Simple API interface for easy integration

Supports common email operations

Limitations

Requires Google API permission settings

Currently only supports basic email functions

Requires a Java environment to run

How to use

Get Google API credentials

Create a Google Cloud project and get OAuth credentials according to the guide.

Configure the credential file

Put the downloaded credentials.json file into the resources directory of the project.

Start the server

Start the Spring Boot server using the Maven command.

Test with the client

Run the ClientStdio class to test the server functions.

Usage examples

Automatically clean up spam emails

Regularly move emails from specific senders to the trash automatically.

Mark emails as read in batches

Mark emails of a specific category (such as promotional emails) as read.

Frequently Asked Questions

Why do I need Google API credentials?

What Gmail operations does the server support?

How can I ensure the security of my emails?

Related resources

Google API Console

Create and manage Google API projects.

Spring Boot Documentation

Official documentation for the Spring Boot framework.

Project GitHub repository

Project source code and issue tracking.

🚀 Gmail MCP Server

This project is a Gmail MCP (Model Context Protocol) server based on Spring Boot. It offers various tools for interacting with Gmail, implemented through the GMailer class. Additionally, the project includes a client ClientStdio for testing the functionality of the MCP server.

🚀 Quick Start

This Gmail MCP server provides a set of tools to interact with Gmail. You can use the GMailer class to perform operations like moving emails to the trash, marking emails as read, sending emails, etc. The ClientStdio class is available for testing the server's functionality.

✨ Features

GMailer Tools:
- trashEmail: Move an email to the trash based on its ID.
- markEmailAsRead: Mark an email as read based on its ID.
- sendEmail: Send an email to a specified recipient.
- getUnreadMessages: Retrieve unread emails.
- readEmail: Read an email based on its ID.
ClientStdio: A client for testing the MCP server's functionality, interacting via standard input and output.

📦 Installation

Prerequisites

Java 17 or higher
Maven
Gmail API credentials

Setup Steps

Clone the repository:

git clone <repository-url>
cd <repository-directory>

Configure Gmail API credentials:
- Create a new Google Cloud project
- Enable the Gmail API
- Configure the OAuth consent screen
  - Select "External". Note that we won't publish this application.
  - Add your personal email address as a "Test user".
- Add the OAuth scope https://www.googleapis.com/auth/gmail/modify
- Create an OAuth client ID for the application, select the application type "Desktop application"
- Download the JSON file of your client OAuth key
- Rename the file to credentials.json and save it to a secure location on your local computer. Remember this location.
- Place the credentials.json file in the src/main/resources directory of the project.
Build the project:
```
mvn clean install
```