Google Workspace

by epaproditus

17 stars
427 downloads
Not rated
GitHub

About

Integrates with Gmail and Google Calendar APIs to enable email and calendar management tasks like listing, searching, and modifying emails, as well as creating and updating events.

Details

Author
epaproditus
Repository
epaproditus/google-workspace-mcp-server
GitHub stars
17
Downloads
427
License
MIT License
Categories
Productivity, Other, Communication, Developer Tools, Design, Workplace, AI, Search, Automation, Security, API

- List, search, send, and modify Gmail emails
- List, create, update, and delete Calendar events
- Gmail email labeling (archive, trash, mark read/unread)
- Calendar event support for attendees and date filtering
- OAuth 2.0 authentication with refresh token

Setting up with Highlight

Follow these steps to add this server as a custom Highlight plugin:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Google Workspace
    Command (node, npx, python, etc.) node
    Arguments
    • Argument 1 /path/to/google-workspace-server/build/index.js
    Environment
    • GOOGLE_CLIENT_ID your_client_id
    • GOOGLE_CLIENT_SECRET your_client_secret
    • GOOGLE_REFRESH_TOKEN your_refresh_token

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

1. Clone and Install:

   git clone https://github.com/epaproditus/google-workspace-mcp-server.git
cd google-workspace-mcp-server
npm install

2. Create OAuth Credentials:
Create a credentials.json file in the root directory:

   {
"web": {
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"redirect_uris": ["http://localhost:4100/code"],
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token"
}
}

3. Get Refresh Token:

   node get-refresh-token.js

This will:
- Open your browser for Google OAuth authentication
- Request the following permissions:
- https://www.googleapis.com/auth/gmail.modify
- https://www.googleapis.com/auth/calendar
- https://www.googleapis.com/auth/gmail.send
- Save the credentials to token.json
- Display the refresh token in the console

4. Configure MCP Settings:
Add the server configuration to your MCP settings file:
- For VSCode Claude extension: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
- For Claude desktop app: ~/Library/Application Support/Claude/claude_desktop_config.json

Add this to the mcpServers object:

   {
"mcpServers": {
"google-workspace": {
"command": "node",
"args": ["/path/to/google-workspace-server/build/index.js"],
"env": {
"GOOGLE_CLIENT_ID": "your_client_id",
"GOOGLE_CLIENT_SECRET": "your_client_secret",
"GOOGLE_REFRESH_TOKEN": "your_refresh_token"
}
}
}
}

5. Build and Run:

   npm run build

list_emails

List recent emails from your inbox with optional filtering.

search_emails

Advanced email search with Gmail query syntax.

send_email

Send new emails with support for CC and BCC.

modify_email

Modify email labels (archive, trash, mark read/unread).

list_events

List upcoming calendar events with date range filtering.

create_event

Create new calendar events with attendees.

update_event

Update existing calendar events.

delete_event

Delete calendar events.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "google workspace": {
            "env": {
                "GOOGLE_CLIENT_ID": "your_client_id",
                "GOOGLE_CLIENT_SECRET": "your_client_secret",
                "GOOGLE_REFRESH_TOKEN": "your_refresh_token"
            },
            "args": [
                "/path/to/google-workspace-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

Linux

{
    "env": {
        "GOOGLE_CLIENT_ID": "your_client_id",
        "GOOGLE_CLIENT_SECRET": "your_client_secret",
        "GOOGLE_REFRESH_TOKEN": "your_refresh_token"
    },
    "args": [
        "/path/to/google-workspace-server/build/index.js"
    ],
    "command": "node"
}

Macos

{
    "env": {
        "GOOGLE_CLIENT_ID": "your_client_id",
        "GOOGLE_CLIENT_SECRET": "your_client_secret",
        "GOOGLE_REFRESH_TOKEN": "your_refresh_token"
    },
    "args": [
        "/path/to/google-workspace-server/build/index.js"
    ],
    "command": "node"
}

Windows

{
    "env": {
        "GOOGLE_CLIENT_ID": "your_client_id",
        "GOOGLE_CLIENT_SECRET": "your_client_secret",
        "GOOGLE_REFRESH_TOKEN": "your_refresh_token"
    },
    "args": [
        "/path/to/google-workspace-server/build/index.js"
    ],
    "command": "node"
}

Google Workspace MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with Gmail and Calendar APIs. This server enables you to manage your emails and calendar events programmatically through the MCP interface.

Features

Gmail Tools

- list_emails: List recent emails from your inbox with optional filtering - search_emails: Advanced email search with Gmail query syntax - send_email: Send new emails with support for CC and BCC - modify_email: Modify email labels (archive, trash, mark read/unread)

Calendar Tools

- list_events: List upcoming calendar events with date range filtering - create_event: Create new calendar events with attendees - update_event: Update existing calendar events - delete_event: Delete calendar events

Prerequisites

1. Node.js: Install Node.js version 14 or higher
2. Google Cloud Console Setup:
- Go to Google Cloud Console
- Create a new project or select an existing one
- Enable the Gmail API and Google Calendar API:
1. Go to "APIs & Services" > "Library"
2. Search for and enable "Gmail API"
3. Search for and enable "Google Calendar API"
- Set up OAuth 2.0 credentials:
1. Go to "APIs & Services" > "Credentials"
2. Click "Create Credentials" > "OAuth client ID"
3. Choose "Web application"
4. Set "Authorized redirect URIs" to include: http://localhost:4100/code
5. Note down the Client ID and Client Secret

Setup Instructions

1. Clone and Install:

   git clone https://github.com/epaproditus/google-workspace-mcp-server.git
cd google-workspace-mcp-server
npm install

2. Create OAuth Credentials:
Create a credentials.json file in the root directory:

   {
"web": {
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"redirect_uris": ["http://localhost:4100/code"],
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token"
}
}

3. Get Refresh Token:

   node get-refresh-token.js

This will:
- Open your browser for Google OAuth authentication
- Request the following permissions:
- https://www.googleapis.com/auth/gmail.modify
- https://www.googleapis.com/auth/calendar
- https://www.googleapis.com/auth/gmail.send
- Save the credentials to token.json
- Display the refresh token in the console

4. Configure MCP Settings:
Add the server configuration to your MCP settings file:
- For VSCode Claude extension: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
- For Claude desktop app: ~/Library/Application Support/Claude/claude_desktop_config.json

Add this to the mcpServers object:

   {
"mcpServers": {
"google-workspace": {
"command": "node",
"args": ["/path/to/google-workspace-server/build/index.js"],
"env": {
"GOOGLE_CLIENT_ID": "your_client_id",
"GOOGLE_CLIENT_SECRET": "your_client_secret",
"GOOGLE_REFRESH_TOKEN": "your_refresh_token"
}
}
}
}

5. Build and Run:

   npm run build

Usage Examples

Gmail Operations

1. List Recent Emails:

   {
"maxResults": 5,
"query": "is:unread"
}

2. Search Emails:

   {
"query": "from:example@gmail.com has:attachment",
"maxResults": 10
}

3. Send Email:

   {
"to": "recipient@example.com",
"subject": "Hello",
"body": "Message content",
"cc": "cc@example.com",
"bcc": "bcc@example.com"
}

4. Modify Email:

   {
"id": "message_id",
"addLabels": ["UNREAD"],
"removeLabels": ["INBOX"]
}

Calendar Operations

1. List Events:

   {
"maxResults": 10,
"timeMin": "2024-01-01T00:00:00Z",
"timeMax": "2024-12-31T23:59:59Z"
}

2. Create Event:

   {
"summary": "Team Meeting",
"location": "Conference Room",
"description": "Weekly sync-up",
"start": "2024-01-24T10:00:00Z",
"end": "2024-01-24T11:00:00Z",
"attendees": ["colleague@example.com"]
}

3. Update Event:

   {
"eventId": "event_id",
"summary": "Updated Meeting Title",
"location": "Virtual",
"start": "2024-01-24T11:00:00Z",
"end": "2024-01-24T12:00:00Z"
}

4. Delete Event:

   {
"eventId": "event_id"
}

Troubleshooting

1. Authentication Issues:
- Ensure all required OAuth scopes are granted
- Verify client ID and secret are correct
- Check if refresh token is valid

2. API Errors:
- Check Google Cloud Console for API quotas and limits
- Ensure APIs are enabled for your project
- Verify request parameters match the required format

License

This project is licensed under the MIT License.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.