MCP Google Workspace

🚀 Model Context Protocol Google Workspace Server

This project provides a server for Google Workspace integration, enabling operations on Gmail and Google Calendar.

🚀 Quick Start

📦 Installation

Install the project dependencies by running the following command:

npm install

💻 Usage Examples

Basic Usage

Start the service: Run the following command to start the server:

npm start

Optional parameters:

• --gauth-file: Specify the path to the OAuth2 credentials file (default is./.gauth.json).
• --accounts-file: Specify the path to the account configuration file (default is./.accounts.json).
• --credentials-dir: Specify the directory to store OAuth credentials (default is the current directory).

Example:

npm start -- --gauth-file ./config/gauth.json --accounts-file ./config/accounts.json

🛠️ Available Tools

Account Management

1. List all configured Google accounts

• Command: gmail_list_accounts or calendar_list_accounts
• Function: Display information about all configured Google accounts, including account metadata and descriptions.
• No user ID required.

Gmail Function Tools

1. Search for emails

• Command: gmail_query_emails
• Function: Search for emails using Gmail's query syntax (e.g., 'is:unread', 'from:example@gmail.com', 'newer_than:2d', 'has:attachment').
• Returns a list of emails sorted in reverse chronological order, including metadata and content summaries.

2. Get an email

• Command: gmail_get_email
• Function: Get the full content of an email by its ID, including the body and attachment information.

3. Bulk get emails

• Command: gmail_bulk_get_emails
• Function: Get the full content of multiple emails at once, suitable for batch processing.

4. Create a draft

• Command: gmail_create_draft
• Function: Create a new email draft.
• Supports Cc recipients.

5. Delete a draft

• Command: gmail_delete_draft
• Function: Delete a draft email by its ID.

6. Reply to an email

• Command: gmail_reply
• Function: Reply to an existing email.
• Options: Send immediately or save as a draft.
• Supports Cc (all recipients).

7. Get an attachment

• Command: gmail_get_attachment
• Function: Download an email attachment.
• Options: Save to local disk or return as an embedded resource.

8. Bulk save attachments

• Command: gmail_bulk_save_attachments
• Function: Save multiple attachments at once.

9. Archive an email

• Command: gmail_archive or gmail_bulk_archive
• Function: Move an email out of the inbox.
• Supports single or batch operations.

Google Calendar Function Tools

1. List calendars

• Command: calendar_list
• Function: Display all accessible calendars.
• Includes calendar metadata, access permissions, and time zone information.

2. Get events

• Command: calendar_get_events
• Function: Get events within a specified date range.
• Supports multiple calendars.
• Filter options (deleted events, maximum number of results).
• Customizable time zone.

3. Create an event

• Command: calendar_create_event
• Function: Create a new calendar event.
• Supports participants and reminders.
• Supports location and description fields.
• Handles time zones.

4. Delete an event

• Command: calendar_delete_event
• Function: Delete an event by its ID.
• Options: Send immediately or save as a draft.
• Supports Cc (all recipients).

📁 Project Structure

src/
├── main.ts        # Main program entry
├── config/       # Configuration folder
│   ├── gauth.json
│   └── accounts.json
└── utils/         # Utility functions
    ├── gmail-service.ts
    └── calendar-service.ts

🛠️ Development Commands

# Start the development server
npm run dev

# Build the project
npm run build

# Run tests
npm test

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.