mcp-google-workspace 0.5.4

MCP Server to connect to Google Workspace (Gmail & Calendar)

mcp-google-workspace MCP server

MCP server to interact with Google Workspace products (Gmail and Calendar).

Example prompts

Right now, this MCP server supports Gmail and Calendar integration with the following capabilities:

1. General

• Multiple google accounts

2. Gmail

• Get your Gmail user information
• Query emails with flexible search (e.g., unread, from specific senders, date ranges, with attachments)
• Retrieve complete email content by ID
• Create new draft emails with:
  • Recipients, subject, and body
  • Optional CC recipients
  • HTML formatting support
  • File attachments
• Send emails directly (not as drafts) with all the above features
• Delete draft emails
• Reply to existing emails with:
  • Support for HTML formatting and attachments
  • Option to send immediately or save as draft
• Retrieve multiple emails at once by their IDs.
• Save multiple attachments from emails to your local system.

3. Calendar

• Manage multiple calendars
• Get calendar events within specified time ranges
• Create calendar events with:
  • Title, start/end times
  • Optional location and description
  • Optional attendees
  • Custom timezone support
  • Notification preferences
• Delete calendar events

Example prompts you can try:

• Retrieve my latest unread messages

• Search my emails from the Scrum Master

• Retrieve all emails from accounting

• Take the email about ABC and summarize it

• Write a nice response to Alice's last email and upload a draft.

• Reply to Bob's email with a Thank you note. Store it as draft

• Create a draft email with the quarterly report attached

• Send an HTML-formatted newsletter to the team with images attached

• Draft a professional email with my resume and cover letter attached

• What do I have on my agenda tomorrow?

• Check my private account's Family agenda for next week

• I need to plan an event with Tim for 2hrs next week. Suggest some time slots.

Quickstart

Install

Installing via PyPI

To install mcp-google-workspace:

pip install mcp-google-workspace

Or with uv:

uv pip install mcp-google-workspace

Oauth 2

Google Workspace (G Suite) APIs require OAuth2 authorization. Follow these steps to set up authentication:

1. Create OAuth2 Credentials:

   • Go to the Google Cloud Console
   • Create a new project or select an existing one
   • Enable the Gmail API and Google Calendar API for your project
   • Go to "Credentials" → "Create Credentials" → "OAuth client ID"
   • Select "Desktop app" or "Web application" as the application type
   • Configure the OAuth consent screen with required information
   • Add authorized redirect URIs (include http://localhost:4100/code for local development)

2. Required OAuth2 Scopes:

   [
     "openid",
     "https://mail.google.com/",
     "https://www.googleapis.com/auth/calendar",
     "https://www.googleapis.com/auth/userinfo.email"
   ]

3. Then create a .gauth.json in your working directory with client

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

4. Create a .accounts.json file with account information

{
    "accounts": [
        {
            "email": "[e-mail]",
            "account_type": "personal",
            "extra_info": "Additional info that you want to tell Claude: E.g. 'Contains Family Calendar'"
        }
    ]
}

You can specifiy multiple accounts. Make sure they have access in your Google Auth app. The extra_info field is especially interesting as you can add info here that you want to tell the AI about the account (e.g. whether it has a specific agenda)

Note: When you first execute one of the tools for a specific account, a browser will open, redirect you to Google and ask for your credentials, scope, etc. After a successful login, it stores the credentials in a local file called .oauth.{email}.json . Once you are authorized, the refresh token will be used.

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration

{
  "mcpServers": {
    "mcp-google-workspace": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/google-mcp",
        "run",
        "mcp-google-workspace"
      ]
    }
  }
}

Note: You can also use the uv run mcp-google-workspace --accounts-file /path/to/custom/.accounts.json to specify a different accounts file or --credentials-dir /path/to/custom/credentials to specify a different credentials directory.

{
  "mcpServers": {
    "mcp-google-workspace": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/google-mcp",
        "run",
        "mcp-google-workspace",
        "--accounts-file",
        "/path/to/custom/.accounts.json",
        "--credentials-dir",
        "/path/to/custom/credentials"
      ]
    }
  }
}

Published Servers Configuration

{
  "mcpServers": {
    "mcp-google-workspace": {
      "command": "uvx",
      "args": [
        "mcp-google-workspace",
        "--accounts-file",
        "/path/to/custom/.accounts.json",
        "--credentials-dir",
        "/path/to/custom/credentials"
      ]
    }
  }
}

Configuration Options

The MCP server can be configured with several command-line options to specify custom paths for authentication and account information:

• --gauth-file: Specifies the path to the .gauth.json file containing OAuth2 client configuration. Default is ./.gauth.json.
• --accounts-file: Specifies the path to the .accounts.json file containing information about the Google accounts. Default is ./.accounts.json.
• --credentials-dir: Specifies the directory where OAuth credentials are stored after successful authentication. Default is the current working directory with a subdirectory for each account as .oauth.{email}.json.

These options allow for flexibility in managing different environments or multiple sets of credentials and accounts, especially useful in development and testing scenarios.

Example usage:

uv run mcp-google-workspace --gauth-file /path/to/custom/.gauth.json --accounts-file /path/to/custom/.accounts.json --credentials-dir /path/to/custom/credentials

This configuration is particularly useful when you have multiple instances of the server running with different configurations or when deploying to environments where the default paths are not suitable.

Development

Building and Publishing

To prepare the package for distribution:

1. Sync dependencies and update lockfile:

uv sync

2. Build package distributions:

uv build

This will create source and wheel distributions in the dist/ directory.

3. Publish to PyPI:

uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

• Token: --token or UV_PUBLISH_TOKEN
• Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /path/to/google-mcp run mcp-google-workspace

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

You can also watch the server logs with this command:

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-google-workspace.log