Gmail

🚀 Gmail MCP Usage Guide

This is an npm package implementing the Model Context Protocol (MCP) for interacting with the Gmail API. It offers standardized interfaces to facilitate email management, sending, and retrieval.

🚀 Quick Start

1. Initialize the Configuration File

Place the configuration file in the corresponding directory based on your operating system:

• Mac/Linux: ~/.config/gmail-mcp/config.json
• Windows: %APPDATA%/gmail-mcp/config.json

Here is an example of the content:

{
  "clientId": "your_client_id",
  "clientSecret": "your_client_secret",
  "refreshToken": "your_refresh_token"
}

2. Initialize the Gmail Client

When initializing the client in your code, you need to specify the path to the configuration file and the default inbox:

import { GmailClient } from '@shinzolabs/gmail-mcp';

// Initialize the Gmail client, defaulting to the development environment mode
const gmail = new GmailClient({
  configFile: process.env.NODE_ENV === 'development' ? '~/.config/gmail-mcp/config.json' : undefined,
  defaultInbox: 'INBOX'
});

// Connect to the Gmail service
await gmail.connect();

✨ Features

This npm package provides standardized interfaces to facilitate interaction with the Gmail API, enabling easy management, sending, and retrieval of emails.

📦 Installation

Install using npm or yarn:

npm install @shinzolabs/gmail-mcp
# or
yarn add @shinzolabs/gmail-mcp

⚠️ Important Note

1. Environment Variable Setup: Ensure that you provide Gmail authorization credentials via environment variables at runtime. Specifically, you need to set the following variables:

   • GMAIL_CLIENT_ID: Client ID
   • GMAIL_CLIENT_SECRET: Client Secret
   • GMAIL_REFRESH_TOKEN: Refresh Token

2. Development and Testing: Avoid using actual production accounts in development and testing environments. It is recommended to create a dedicated Gmail account for testing.

💻 Usage Examples

Basic Usage

The above quick - start steps show the basic usage of initializing the configuration file and the Gmail client.

📚 Documentation

Supported API Endpoints

User Management

• get_profile: Get the Gmail profile information of the current user.
• stop_mail_watch: Stop receiving email push notifications.
• watch_mailbox: Enable the push notification function for mailbox changes.

Message Management

Message Operations

• list_messages: List messages that meet the criteria.
• get_message: Get the specific content of a specified message.
• get_attachment: Download attachments from a specific message.
• modify_message: Modify message label information.
• send_message: Send an email to the specified recipient.
• delete_message: Permanently delete a message.
• trash_message: Move a message to the trash.
• untrash_message: Remove a message from the trash.
• batch_modify_messages: Batch modify the labels of multiple messages.
• batch_delete_messages: Batch delete multiple messages.

Label Management

• list_labels: List all existing labels.
• get_label: Get detailed information about a specific label.
• create_label: Create a new label.
• update_label: Update label configuration information.
• patch_label: Partially update label information (only modify specified fields).
• delete_label: Delete a label.

Thread Management

• list_threads: List all email threads.
• get_thread: Get detailed content of a specific thread.
• modify_thread: Modify relevant attributes of a thread.
• trash_thread: Move an entire thread to the trash.
• untrash_thread: Restore an entire thread from the trash.

Inbox Management

• list_inboxes: Get a list of all available inboxes.
• get_inbox: Get detailed information about a specified inbox.
• select_inbox: Switch to a specified inbox for operations.
• create_inbox: Create a new inbox (only available to administrators).
• delete_inbox: Delete a specified inbox (only available to administrators).

📄 Feedback

If you encounter any problems or need further support, please contact our team:

• Email: support@shinzolabs.com
• GitHub Repository: Go to the project repository

Thank you for using Gmail MCP!