Gmail MCP Server Yv2

🚀 Gmail Server for Model Context Protocol (MCP)

This MCP server integrates with Gmail to enable functions such as sending, deleting, reading, composing, and replying to emails.

⚠️ Important Note

This server allows MCP clients to read, delete, and send emails. However, the client will prompt the user before performing such operations.

GitHub Resource Link

✨ Features

Tools

• send-email

  • Send an email to the specified recipient address.
  • Input:
    • recipient_id (string): Recipient's email address.
    • subject (string): Email subject.
    • message (string): Email content.
  • Returns the status and message ID.

• trash-email

  • Move an email to the trash.
  • Input:
    • email_id (string): Automatically generated email ID.
  • Returns a success message.

• mark-email-as-read

  • Mark an email as read.
  • Input:
    • email_id (string): Automatically generated email ID.
  • Returns a success message.

• get-unread-emails

  • Retrieve unread emails.
  • Returns a list of unread emails, including email IDs.

• read-email

  • Retrieve the content of a specified email.
  • Input:
    • email_id (string): Automatically generated email ID.
  • Returns a dictionary containing email metadata and marks the email as read.

• open-email

  • Open an email in the browser.
  • Input:
    • email_id (string): Automatically generated email ID.
  • Returns a success message and opens the specified email in the default browser.

📦 Installation

Gmail API Configuration

1. Create a new Google Cloud project.
2. Enable the Gmail API.
3. Configure the OAuth consent screen:
   • Select "External". Note that we won't publish this application.
   • Add your personal email address as a "Test user".
4. Add the OAuth scope https://www.googleapis.com/auth/gmail/modify.
5. Create an OAuth client ID of the application type, selecting "Desktop application".
6. Download the JSON file of your client's OAuth key.
7. Rename the key file and save it to a secure location on your local computer. Remember this location.
   • When starting the server, pass the absolute path of this file via the parameter --creds-file-path.

Authentication

When starting the server, the authentication process will automatically start in your system browser.

• Follow the on-screen instructions to grant permissions and complete the setup.

💻 Usage Examples

Basic Usage

1. Install the necessary dependencies:

   • Use pip to install the required libraries (e.g., google-api-python-client, etc.).

2. Configure environment variables:

   • Set the Google API access information, including the client ID and client secret.

3. Start the server:

   • Use the provided command to start the server and specify the paths for crets-file-path and access-tokens-file.

📚 Documentation

Troubleshooting

• If you encounter issues, check the following:
  • Ensure that the Google API project is correctly configured.
  • Ensure that the OAuth process is completed without errors.
  • Check the logs for more information.

By following the above steps, you can successfully set up the Gmail MCP server and integrate it into your application!