Gmail AutoAuth MCP Server
About
Server for Gmail integration in Claude Desktop with auto authentication support. This server enables AI assistants to manage Gmail through natural language interactions.
Details
- Author
- GongRzhe
- Repository
- GongRzhe/Gmail-MCP-Server
- GitHub stars
- 182
- Downloads
- 12
- License
- MIT License
- Categories
- Communication, Other, Automation, AI, Productivity, Developer Tools, Design, Search, API
- Tags
- #google, #web
Jump to
- Send emails with subject, content, attachments, and recipients
- Full attachment support - send and receive file attachments
- Download email attachments to local filesystem
- Support for HTML emails and multipart messages with both HTML and plain text versions
- Full support for international characters in subject lines and email content
- Read email messages by ID with advanced MIME structure handling
- Enhanced attachment display showing filenames, types, sizes, and download IDs
- Search emails with various criteria (subject, sender, date range)
- Comprehensive label management with ability to create, update, delete and list labels
- List all available Gmail labels (system and user-defined)
- List emails in inbox, sent, or custom labels
- Mark emails as read/unread
- Move emails to different labels/folders
- Delete emails
- Batch operations for efficiently processing multiple emails at once
- Full integration with Gmail API
- Simple OAuth2 authentication flow with auto browser launch
- Support for both Desktop and Web application credentials
- Global credential storage for convenience
Setting up with Highlight
Follow these steps to add this server as a custom Highlight plugin:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Gmail AutoAuth MCP ServerCommand (node, npx, python, etc.)npxArguments-
Argument 1
@gongrzhe/server-gmail-autoauth-mcp
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
-
Argument 1
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
To install Gmail AutoAuth for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @gongrzhe/server-gmail-autoauth-mcp --client claude
1. Create a Google Cloud Project and obtain credentials:
a. Create a Google Cloud Project:
- Go to Google Cloud Console
- Create a new project or select an existing one
- Enable the Gmail API for your project
b. Create OAuth 2.0 Credentials:
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth client ID"
- Choose either "Desktop app" or "Web application" as application type
- Give it a name and click "Create"
- For Web application, add http://localhost:3000/oauth2callback to the authorized redirect URIs
- Download the JSON file of your client's OAuth keys
- Rename the key file to gcp-oauth.keys.json
2. Run Authentication:
You can authenticate in two ways:
a. Global Authentication (Recommended):
npx @gongrzhe/server-gmail-autoauth-mcp auth
b. Local Authentication:
npx @gongrzhe/server-gmail-autoauth-mcp auth
The authentication process will:
- Look for gcp-oauth.keys.json in the current directory or ~/.gmail-mcp/
- If found in current directory, copy it to ~/.gmail-mcp/
- Open your default browser for Google authentication
- Save credentials as ~/.gmail-mcp/credentials.json
> Note:
> - After successful authentication, credentials are stored globally in ~/.gmail-mcp/ and can be used from any directory
> - Both Desktop app and Web application credentials are supported
> - For Web application credentials, make sure to add http://localhost:3000/oauth2callback to your authorized redirect URIs
3. Configure in Claude Desktop:
{
"mcpServers": {
"gmail": {
"command": "npx",
"args": [
"@gongrzhe/server-gmail-autoauth-mcp"
]
}
}
}
For cloud server environments (like n8n), you can specify a custom callback URL during authentication:
npx @gongrzhe/server-gmail-autoauth-mcp auth https://gmail.gongrzhe.com/oauth2callback
1. Configure Reverse Proxy:
- Set up your n8n container to expose a port for authentication
- Configure a reverse proxy to forward traffic from your domain (e.g., gmail.gongrzhe.com) to this port
2. DNS Configuration:
- Add an A record in your DNS settings to resolve your domain to your cloud server's IP address
3. Google Cloud Platform Setup:
- In your Google Cloud Console, add your custom domain callback URL (e.g., https://gmail.gongrzhe.com/oauth2callback) to the authorized redirect URIs list
4. Run Authentication:
npx @gongrzhe/server-gmail-autoauth-mcp auth https://gmail.gongrzhe.com/oauth2callback
5. Configure in your application:
{
"mcpServers": {
"gmail": {
"command": "npx",
"args": [
"@gongrzhe/server-gmail-autoauth-mcp"
]
}
}
}
This approach allows authentication flows to work properly in environments where localhost isn't accessible, such as containerized applications or cloud servers.
send_email
Sends a new email immediately. Supports plain text, HTML, or multipart emails with optional file attachments.
draft_email
Creates a draft email without sending it. Also supports attachments.
read_email
Retrieves the content of a specific email by its ID, showing enhanced attachment information.
download_attachment
Downloads email attachments to your local filesystem. Parameters: messageId (string), attachmentId (string), savePath (optional string), filename (optional string).
search_emails
Searches for emails using Gmail search syntax. Parameters: query (string), maxResults (optional integer).
modify_email
Adds or removes labels from emails. Parameters: messageId (string), addLabelIds (array of strings), removeLabelIds (array of strings).
delete_email
Permanently deletes an email. Parameters: messageId (string).
list_email_labels
Retrieves all available Gmail labels.
create_label
Creates a new Gmail label. Parameters: name (string), messageListVisibility (string), labelListVisibility (string).
update_label
Updates an existing Gmail label. Parameters: id (string), name (string), messageListVisibility (string), labelListVisibility (string).
delete_label
Deletes a Gmail label. Parameters: id (string).
get_or_create_label
Gets an existing label by name or creates it if it doesn't exist. Parameters: name (string), messageListVisibility (string), labelListVisibility (string).
batch_modify_emails
Modifies labels for multiple emails in efficient batches. Parameters: messageIds (array of strings), addLabelIds (array of strings), removeLabelIds (array of strings), batchSize (optional integer).
batch_delete_emails
Permanently deletes multiple emails in efficient batches. Parameters: messageIds (array of strings), batchSize (optional integer).
create_filter
Creates a new Gmail filter with custom criteria and actions. Parameters: criteria (object), action (object).
list_filters
Retrieves all Gmail filters.
get_filter
Gets details of a specific Gmail filter. Parameters: filterId (string).
delete_filter
Deletes a Gmail filter. Parameters: filterId (string).
create_filter_from_template
Creates a filter using pre-defined templates for common scenarios. Parameters: template (string), parameters (object).
The server provides the following tools that can be used through Claude Desktop:
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"gmail autoauth mcp server": {
"env": {},
"args": [
"@gongrzhe/server-gmail-autoauth-mcp"
],
"command": "npx"
}
}
}
Linux
{
"env": [],
"args": [
"@gongrzhe/server-gmail-autoauth-mcp"
],
"command": "npx"
}
Macos
{
"env": [],
"args": [
"@gongrzhe/server-gmail-autoauth-mcp"
],
"command": "npx"
}
Windows
{
"env": [],
"args": [
"/c",
"npx",
"@gongrzhe/server-gmail-autoauth-mcp"
],
"command": "cmd"
}
An MCP server for integrating Gmail with auto-authentication support.
A Model Context Protocol (MCP) server for Gmail integration in Claude Desktop with auto authentication support. This server enables AI assistants to manage Gmail through natural language interactions.
- Send emails with subject, content,attachments, and recipients
- Full attachment support- send and receive file attachments
- Download email attachmentsto local filesystem
- Support for HTML emails and multipart messages with both HTML and plain text versions
- Full support for international characters in subject lines and email content
- Read email messages by ID with advanced MIME structure handling
- Enhanced attachment displayshowing filenames, types, sizes, and download IDs
- Search emails with various criteria (subject, sender, date range)
- Comprehensive label management with ability to create, update, delete and list labels
- List all available Gmail labels (system and user-defined)
- List emails in inbox, sent, or custom labels
- Mark emails as read/unread
- Move emails to different labels/folders
- Delete emails
- Batch operations for efficiently processing multiple emails at once
- Full integration with Gmail API
- Simple OAuth2 authentication flow with auto browser launch
- Support for both Desktop and Web application credentials
- Global credential storage for convenience
To install Gmail AutoAuth for Claude Desktop automatically viaSmithery:
npx -y @smithery/cli install @gongrzhe/server-gmail-autoauth-mcp --client claude
-
Create a Google Cloud Project and obtain credentials:
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth client ID"
- Choose either "Desktop app" or "Web application" as application type
- Give it a name and click "Create"
- For Web application, addhttp://localhost:3000/oauth2callbackto the authorized redirect URIs
- Download the JSON file of your client's OAuth keys
- Rename the key file togcp-oauth.keys.json
# First time: Place gcp-oauth.keys.json in your home directory's .gmail-mcp folder mkdir -p ~/.gmail-mcp mv gcp-oauth.keys.json ~/.gmail-mcp/ # Run authentication from anywhere npx @gongrzhe/server-gmail-autoauth-mcp auth
# Place gcp-oauth.keys.json in your current directory # The file will be automatically copied to global config npx @gongrzhe/server-gmail-autoauth-mcp auth
- Look forgcp-oauth.keys.jsonin the current directory or~/.gmail-mcp/
- If found in current directory, copy it to~/.gmail-mcp/
- Open your default browser for Google authentication
- Save credentials as~/.gmail-mcp/credentials.json
- After successful authentication, credentials are stored globally in~/.gmail-mcp/and can be used from any directory
- Both Desktop app and Web application credentials are supported
- For Web application credentials, make sure to addhttp://localhost:3000/oauth2callbackto your authorized redirect URIs
{ "mcpServers": { "gmail": { "command": "npx", "args": [ "@gongrzhe/server-gmail-autoauth-mcp" ] } } }
docker run -i --rm \ --mount type=bind,source=/path/to/gcp-oauth.keys.json,target=/gcp-oauth.keys.json \ -v mcp-gmail:/gmail-server \ -e GMAIL_OAUTH_PATH=/gcp-oauth.keys.json \ -e "GMAIL_CREDENTIALS_PATH=/gmail-server/credentials.json" \ -p 3000:3000 \ mcp/gmail auth
{ "mcpServers": { "gmail": { "command": "docker", "args": [ "run", "-i", "--rm", "-v", "mcp-gmail:/gmail-server", "-e", "GMAIL_CREDENTIALS_PATH=/gmail-server/credentials.json", "mcp/gmail" ] } } }
For cloud server environments (like n8n), you can specify a custom callback URL during authentication:
npx @gongrzhe/server-gmail-autoauth-mcp auth https://gmail.gongrzhe.com/oauth2callback
Setup Instructions for Cloud Environment
- Set up your n8n container to expose a port for authentication
- Configure a reverse proxy to forward traffic from your domain (e.g.,gmail.gongrzhe.com) to this port
- Add an A record in your DNS settings to resolve your domain to your cloud server's IP address
- In your Google Cloud Console, add your custom domain callback URL (e.g.,https://gmail.gongrzhe.com/oauth2callback) to the authorized redirect URIs list
npx @gongrzhe/server-gmail-autoauth-mcp auth https://gmail.gongrzhe.com/oauth2callback
{ "mcpServers": { "gmail": { "command": "npx", "args": [ "@gongrzhe/server-gmail-autoauth-mcp" ] } } }
This approach allows authentication flows to work properly in environments where localhost isn't accessible, such as containerized applications or cloud servers.
The server provides the following tools that can be used through Claude Desktop:
Sends a new email immediately. Supports plain text, HTML, or multipart emailswith optional file attachments.
{ "to": ["recipient@example.com"], "subject": "Meeting Tomorrow", "body": "Hi,\n\nJust a reminder about our meeting tomorrow at 10 AM.\n\nBest regards", "cc": ["cc@example.com"], "bcc": ["bcc@example.com"], "mimeType": "text/plain" }
{ "to": ["recipient@example.com"], "subject": "Project Files", "body": "Hi,\n\nPlease find the project files attached.\n\nBest regards", "attachments": [ "/path/to/document.pdf", "/path/to/spreadsheet.xlsx", "/path/to/presentation.pptx" ] }
{ "to": ["recipient@example.com"], "subject": "Meeting Tomorrow", "mimeType": "text/html", "body": "<html><body><h1>Meeting Reminder</h1><p>Just a reminder about our <b>meeting tomorrow</b> at 10 AM.</p><p>Best regards</p></body></html>" }
Multipart Email Example (HTML + Plain Text):
{ "to": ["recipient@example.com"], "subject": "Meeting Tomorrow", "mimeType": "multipart/alternative", "body": "Hi,\n\nJust a reminder about our meeting tomorrow at 10 AM.\n\nBest regards", "htmlBody": "<html><body><h1>Meeting Reminder</h1><p>Just a reminder about our <b>meeting tomorrow</b> at 10 AM.</p><p>Best regards</p></body></html>" }
Creates a draft email without sending it.Also supports attachments.
{ "to": ["recipient@example.com"], "subject": "Draft Report", "body": "Here's the draft report for your review.", "cc": ["manager@example.com"], "attachments": ["/path/to/draft_report.docx"] }
Retrieves the content of a specific email by its ID.Now shows enhanced attachment information.
{ "messageId": "182ab45cd67ef" }
Enhanced Response includes attachment details:
Subject: Project Files From: sender@example.com To: recipient@example.com Date: Thu, 19 Jun 2025 10:30:00 -0400 Email body content here... Attachments (2): - document.pdf (application/pdf, 245 KB, ID: ANGjdJ9fkTs-i3GCQo5o97f_itG...) - spreadsheet.xlsx (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, 89 KB, ID: BWHkeL8gkUt-j4HDRp6o98g_juI...)
4.Download Attachment (download_attachment)
NEW: Downloads email attachments to your local filesystem.
{ "messageId": "182ab45cd67ef", "attachmentId": "ANGjdJ9fkTs-i3GCQo5o97f_itG...", "savePath": "/path/to/downloads", "filename": "downloaded_document.pdf" }
- messageId: The ID of the email containing the attachment
- attachmentId: The attachment ID (shown in enhanced email display)
- savePath: Directory to save the file (optional, defaults to current directory)
- filename: Custom filename (optional, uses original filename if not provided)
Searches for emails using Gmail search syntax.
{ "query": "from:sender@example.com after:2024/01/01 has:attachment", "maxResults": 10 }
Adds or removes labels from emails (move to different folders, archive, etc.).
{ "messageId": "182ab45cd67ef", "addLabelIds": ["IMPORTANT"], "removeLabelIds": ["INBOX"] }
{ "messageId": "182ab45cd67ef" }
8. List Email Labels (list_email_labels)
{ "name": "Important Projects", "messageListVisibility": "show", "labelListVisibility": "labelShow" }
{ "id": "Label_1234567890", "name": "Urgent Projects", "messageListVisibility": "show", "labelListVisibility": "labelShow" }
{ "id": "Label_1234567890" }
12. Get or Create Label (get_or_create_label)
Gets an existing label by name or creates it if it doesn't exist.
{ "name": "Project XYZ", "messageListVisibility": "show", "labelListVisibility": "labelShow" }
13. Batch Modify Emails (batch_modify_emails)
Modifies labels for multiple emails in efficient batches.
{ "messageIds": ["182ab45cd67ef", "182ab45cd67eg", "182ab45cd67eh"], "addLabelIds": ["IMPORTANT"], "removeLabelIds": ["INBOX"], "batchSize": 50 }
14. Batch Delete Emails (batch_delete_emails)
Permanently deletes multiple emails in efficient batches.
{ "messageIds": ["182ab45cd67ef", "182ab45cd67eg", "182ab45cd67eh"], "batchSize": 50 }
Creates a new Gmail filter with custom criteria and actions.
{ "criteria": { "from": "newsletter@company.com", "hasAttachment": false }, "action": { "addLabelIds": ["Label_Newsletter"], "removeLabelIds": ["INBOX"] } }
Gets details of a specific Gmail filter.
{ "filterId": "ANe1Bmj1234567890" }
{ "filterId": "ANe1Bmj1234567890" }
18. Create Filter from Template (create_filter_from_template)
Creates a filter using pre-defined templates for common scenarios.
{ "template": "fromSender", "parameters": { "senderEmail": "notifications@github.com", "labelIds": ["Label_GitHub"], "archive": true } }
You can create filters based on various criteria:
Filters can perform the following actions:
The server includes pre-built templates for common filtering scenarios:
Filters emails from a specific sender and optionally archives them.
{ "template": "fromSender", "parameters": { "senderEmail": "newsletter@company.com", "labelIds": ["Label_Newsletter"], "archive": true } }
2. Subject Filter Template (withSubject)
Filters emails with specific subject text and optionally marks as read.
{ "template": "withSubject", "parameters": { "subjectText": "[URGENT]", "labelIds": ["Label_Urgent"], "markAsRead": false } }
3. Attachment Filter Template (withAttachments)
{ "template": "withAttachments", "parameters": { "labelIds": ["Label_Attachments"] } }
Filters emails larger than a specified size.
{ "template": "largeEmails", "parameters": { "sizeInBytes": 10485760, "labelIds": ["Label_Large"] } }
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.


