MCP ExplorerExplorer

Gongrzhe Gmail Mcp Server

@MCP-Mirroron 10 months ago
1 MIT
FreeCommunity
AI Systems
https://github.com/GongRzhe/Gmail-MCP-Server 的镜像

Overview

What is Gongrzhe Gmail Mcp Server

GongRzhe_Gmail-MCP-Server is a Model Context Protocol (MCP) server designed for Gmail integration with auto authentication support, enabling AI assistants to manage Gmail through natural language interactions.

Use cases

Use cases include automating email responses, managing email organization, integrating Gmail functionalities into AI assistants, and enhancing user interactions with email through natural language processing.

How to use

To use GongRzhe_Gmail-MCP-Server, you can install it via Smithery using the command ‘npx -y @smithery/cli install @gongrzhe/server-gmail-autoauth-mcp --client claude’. Alternatively, you can manually set it up by creating a Google Cloud Project and obtaining OAuth 2.0 credentials.

Key features

Key features include sending emails with attachments, reading emails by ID, searching emails with various criteria, listing emails in different folders, marking emails as read/unread, moving emails, deleting emails, full integration with Gmail API, simple OAuth2 authentication, and global credential storage.

Where to use

GongRzhe_Gmail-MCP-Server can be used in various fields where Gmail integration is required, such as AI development, customer support automation, and personal productivity tools.

Content

Gmail AutoAuth MCP Server

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.

smithery badge
License: ISC

Features

  • Send emails with subject, content, attachments, and recipients
  • Read email messages by ID
  • Search emails with various criteria (subject, sender, date range)
  • List emails in inbox, sent, or custom labels
  • Mark emails as read/unread
  • Move emails to different labels/folders
  • Delete emails
  • 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

Installation & Authentication

Installing via Smithery

To install Gmail AutoAuth for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @gongrzhe/server-gmail-autoauth-mcp --client claude

Installing Manually

  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):

    # 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
    

    b. Local Authentication:

    # 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
    

    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"
      ]
    }
  }
}

Docker Support

If you prefer using Docker:

  1. Authentication:
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
  1. Usage:
{
  "mcpServers": {
    "gmail": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v",
        "mcp-gmail:/gmail-server",
        "-e",
        "GMAIL_CREDENTIALS_PATH=/gmail-server/credentials.json",
        "mcp/gmail"
      ]
    }
  }
}

Usage Examples

The server provides several tools that can be used through the Claude Desktop:

Send Email

{
  "to": [
    "[email protected]"
  ],
  "subject": "Meeting Tomorrow",
  "body": "Hi,\n\nJust a reminder about our meeting tomorrow at 10 AM.\n\nBest regards",
  "cc": [
    "[email protected]"
  ],
  "bcc": [
    "[email protected]"
  ]
}

Search Emails

{
  "query": "from:[email protected] after:2024/01/01",
  "maxResults": 10
}

Read Email

{
  "messageId": "message123"
}

Move Email

{
  "messageId": "message123",
  "labelIds": [
    "INBOX",
    "IMPORTANT"
  ]
}

Security Notes

  • OAuth credentials are stored securely in your local environment (~/.gmail-mcp/)
  • The server uses offline access to maintain persistent authentication
  • Never share or commit your credentials to version control
  • Regularly review and revoke unused access in your Google Account settings
  • Credentials are stored globally but are only accessible by the current user

Troubleshooting

  1. OAuth Keys Not Found

    • Make sure gcp-oauth.keys.json is in either your current directory or ~/.gmail-mcp/
    • Check file permissions
  2. Invalid Credentials Format

    • Ensure your OAuth keys file contains either web or installed credentials
    • For web applications, verify the redirect URI is correctly configured
  3. Port Already in Use

    • If port 3000 is already in use, please free it up before running authentication
    • You can find and stop the process using that port

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the ISC License.

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

Tools

No tools

Comments

Recommend MCP Servers

View All MCP Servers