google_workspace_mcp
Comprehensive Google Workspace MCP server with full support for Google Calendar, Drive, Gmail, and Docs, Forms, Chats, Slides and Sheets over stdio, Streamable HTTP and SSE transports.
README Documentation
Google Workspace MCP Server 
Full natural language control over Google Calendar, Drive, Gmail, Docs, Sheets, Slides, Forms, Tasks, and Chat through all MCP clients, AI assistants and developer tools.
The most feature-complete Google Workspace MCP server, now with Remote OAuth2.1 multi-user support and 1-click Claude installation.
Support for all free Google accounts (Gmail, Docs, Drive etc) & Google Workspace plans (Starter, Standard, Plus, Enterprise, Non Profit) with expanded app options like Chat & Spaces.
Interested in a private cloud instance? That can be arranged.
See it in action:
A quick plug for AI-Enhanced Docs
◆ But why?
This README was written with AI assistance, and here's why that matters
As a solo dev building open source tools, comprehensive documentation often wouldn't happen without AI help. Using agentic dev tools like Roo & Claude Code that understand the entire codebase, AI doesn't just regurgitate generic content - it extracts real implementation details and creates accurate, specific documentation.
In this case, Sonnet 4 took a pass & a human (me) verified them 8/16/25.
Overview
A production-ready MCP server that integrates all major Google Workspace services with AI assistants. It supports both single-user operation and multi-user authentication via OAuth 2.1, making it a powerful backend for custom applications. Built with FastMCP for optimal performance, featuring advanced authentication handling, service caching, and streamlined development patterns.
Simplified Setup: Now uses Google Desktop OAuth clients - no redirect URIs or port configuration needed!
Features
@ Gmail • ≡ Drive • ⧖ Calendar ≡ Docs
≡ Forms • @ Chat • ≡ Sheets • ≡ Slides
|
⊠ Authentication & Security
✓ Tasks • ◆ Custom Search • ↻ Transport Support
|
▶ Quick Start
≡ Quick Reference Card ← Essential commands & configs at a glance
⊠ Credentials
|
▶ Launch Commands
|
★ Tool Tiers
|
1. One-Click Claude Desktop Install (Recommended)
- Download: Grab the latest
google_workspace_mcp.dxt
from the “Releases” page - Install: Double-click the file – Claude Desktop opens and prompts you to Install
- Configure: In Claude Desktop → Settings → Extensions → Google Workspace MCP, paste your Google OAuth credentials
- Use it: Start a new Claude chat and call any Google Workspace tool
Why DXT?
Desktop Extensions (
.dxt
) bundle the server, dependencies, and manifest so users go from download → working MCP in one click – no terminal, no JSON editing, no version conflicts.
Required Configuration
◆ Environment Variables ← Click to configure in Claude Desktop
Required
|
Optional
|
Claude Desktop stores these securely in the OS keychain; set them once in the extension pane.
Prerequisites
- Python 3.10+
- uvx (for instant installation) or uv (for development)
- Google Cloud Project with OAuth 2.0 credentials
Configuration
◆ Google Cloud Setup ← OAuth 2.0 credentials & API enablement
1. Create Project
|
2. OAuth Credentials
Download & save credentials |
3. Enable APIs
See quick links below |
≡ OAuth Credential Setup Guide ← Step-by-step instructionsComplete Setup Process:
|
⊥ Quick API Enable Links ← One-click enable each Google API
You can enable each one by clicking the links below (make sure you're logged into the Google Cloud Console and have the correct project selected):1.1. Credentials: See Credential Configuration for detailed setup options
- Environment Configuration:
◆ Environment Variables ← Configure your runtime environment
◆ Development Mode
Allows HTTP redirect URIs |
@ Default User
Single-user authentication |
◆ Custom Search
Optional: Search API setup |
- Server Configuration:
◆ Server Settings ← Customize ports, URIs & proxies
◆ Base Configuration
Server URL & port settings |
↻ Proxy Support
Leverage multi-user OAuth2.1 clients |
@ Default Email
Skip email in auth flows in single user mode |
≡ Configuration Details ← Learn more about each setting
Variable | Description | Default |
---|---|---|
WORKSPACE_MCP_BASE_URI | Base server URI (no port) | http://localhost |
WORKSPACE_MCP_PORT | Server listening port | 8000 |
WORKSPACE_EXTERNAL_URL | External URL for reverse proxy setups | None |
GOOGLE_OAUTH_REDIRECT_URI | Override OAuth callback URL | Auto-constructed |
USER_GOOGLE_EMAIL | Default auth email | None |
Google Custom Search Setup
◆ Custom Search Configuration ← Enable web search capabilities
1. Create Search Engine
|
2. Get API Key
|
3. Set Variables
Configure in environment |
≡ Quick Setup Guide ← Step-by-step instructionsComplete Setup Process:
|
Start the Server
▶ Launch Commands ← Choose your startup mode
▶ Quick Start
Default stdio mode |
◆ HTTP Mode
Web interfaces & debugging |
@ Single User
Simplified authentication |
◆ Advanced Options ← Tool selection, tiers & Docker▶ Selective Tool Loading
★ Tool Tiers
◆ Docker Deployment
Available Services: |
Tool Tiers
The server organizes tools into three progressive tiers for simplified deployment. Choose a tier that matches your usage needs and API quota requirements.
Available Tiers● Core ( ● Extended ( ● Complete ( |
Important Notes▶ Start with |
Usage Examples
# Basic tier selection
uv run main.py --tool-tier core # Start with essential tools only
uv run main.py --tool-tier extended # Expand to include management features
uv run main.py --tool-tier complete # Enable all available functionality
# Selective service loading with tiers
uv run main.py --tools gmail drive --tool-tier core # Core tools for specific services
uv run main.py --tools gmail --tool-tier extended # Extended Gmail functionality only
uv run main.py --tools docs sheets --tool-tier complete # Full access to Docs and Sheets
📋 Credential Configuration
🔑 OAuth Credentials Setup ← Essential for all installations
🚀 Environment Variables
Best for production |
📁 File-based
Traditional method |
⚡ .env File
Best for development |
📖 Credential Loading Details ← Understanding priority & best practicesLoading Priority
Why Environment Variables?
|
🧰 Available Tools
Note: All tools support automatic authentication via
@require_google_service()
decorators with 30-minute service caching.
📅 Google Calendar
|
Tool | Tier | Description |
---|---|---|
list_calendars | Core | List accessible calendars |
get_events | Core | Retrieve events with time range filtering |
create_event | Core | Create events with attachments & reminders |
modify_event | Core | Update existing events |
delete_event | Extended | Remove events |
📁 Google Drive drive_tools.py
Tool | Tier | Description |
---|---|---|
search_drive_files | Core | Search files with query syntax |
get_drive_file_content | Core | Read file content (Office formats) |
list_drive_items | Extended | List folder contents |
create_drive_file | Core | Create files or fetch from URLs |
📧 Gmail gmail_tools.py
Tool | Tier | Description |
---|---|---|
search_gmail_messages | Core | Search with Gmail operators |
get_gmail_message_content | Core | Retrieve message content |
get_gmail_messages_content_batch | Core | Batch retrieve message content |
send_gmail_message | Core | Send emails |
get_gmail_thread_content | Extended | Get full thread content |
modify_gmail_message_labels | Extended | Modify message labels |
list_gmail_labels | Extended | List available labels |
manage_gmail_label | Extended | Create/update/delete labels |
draft_gmail_message | Extended | Create drafts |
get_gmail_threads_content_batch | Complete | Batch retrieve thread content |
batch_modify_gmail_message_labels | Complete | Batch modify labels |
start_google_auth | Complete | Initialize authentication |
📝 Google Docs docs_tools.py
Tool | Tier | Description |
---|---|---|
get_doc_content | Core | Extract document text |
create_doc | Core | Create new documents |
modify_doc_text | Core | Modify document text |
search_docs | Extended | Find documents by name |
find_and_replace_doc | Extended | Find and replace text |
list_docs_in_folder | Extended | List docs in folder |
insert_doc_elements | Extended | Add tables, lists, page breaks |
insert_doc_image | Complete | Insert images from Drive/URLs |
update_doc_headers_footers | Complete | Modify headers and footers |
batch_update_doc | Complete | Execute multiple operations |
inspect_doc_structure | Complete | Analyze document structure |
create_table_with_data | Complete | Create data tables |
debug_table_structure | Complete | Debug table issues |
*_document_comments | Complete | Read, Reply, Create, Resolve |
📊 Google Sheets sheets_tools.py
Tool | Tier | Description |
---|---|---|
read_sheet_values | Core | Read cell ranges |
modify_sheet_values | Core | Write/update/clear cells |
create_spreadsheet | Core | Create new spreadsheets |
list_spreadsheets | Extended | List accessible spreadsheets |
get_spreadsheet_info | Extended | Get spreadsheet metadata |
create_sheet | Complete | Add sheets to existing files |
*_sheet_comment | Complete | Read/create/reply/resolve comments |
🖼️ Google Slides slides_tools.py
Tool | Tier | Description |
---|---|---|
create_presentation | Core | Create new presentations |
get_presentation | Core | Retrieve presentation details |
batch_update_presentation | Extended | Apply multiple updates |
get_page | Extended | Get specific slide information |
get_page_thumbnail | Extended | Generate slide thumbnails |
*_presentation_comment | Complete | Read/create/reply/resolve comments |
📝 Google Forms forms_tools.py
Tool | Tier | Description |
---|---|---|
create_form | Core | Create new forms |
get_form | Core | Retrieve form details & URLs |
set_publish_settings | Complete | Configure form settings |
get_form_response | Complete | Get individual responses |
list_form_responses | Extended | List all responses with pagination |
✓ Google Tasks tasks_tools.py
Tool | Tier | Description |
---|---|---|
list_tasks | Core | List tasks with filtering |
get_task | Core | Retrieve task details |
create_task | Core | Create tasks with hierarchy |
update_task | Core | Modify task properties |
delete_task | Extended | Remove tasks |
move_task | Complete | Reposition tasks |
clear_completed_tasks | Complete | Hide completed tasks |
*_task_list | Complete | List/get/create/update/delete task lists |
💬 Google Chat chat_tools.py
Tool | Tier | Description |
---|---|---|
list_spaces | Extended | List chat spaces/rooms |
get_messages | Core | Retrieve space messages |
send_message | Core | Send messages to spaces |
search_messages | Core | Search across chat history |
🔍 Google Custom Search search_tools.py
Tool | Tier | Description |
---|---|---|
search_custom | Core | Perform web searches |
get_search_engine_info | Complete | Retrieve search engine metadata |
search_custom_siterestrict | Extended | Search within specific domains |
Tool Tier Legend:
- • Core: Essential tools for basic functionality • Minimal API usage • Getting started
- • Extended: Core tools + additional features • Regular usage • Expanded capabilities
- • Complete: All available tools including advanced features • Power users • Full API access
Connect to Claude Desktop
The server supports two transport modes:
Stdio Mode (Default - Recommended for Claude Desktop)
In general, you should use the one-click DXT installer package for Claude Desktop.
If you are unable to for some reason, you can configure it manually via claude_desktop_config.json
Manual Claude Configuration (Alternative)
📝 Claude Desktop JSON Config ← Click for manual setup instructions
-
Open Claude Desktop Settings → Developer → Edit Config
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
-
Add the server configuration:
{
"mcpServers": {
"google_workspace": {
"command": "uvx",
"args": ["workspace-mcp"],
"env": {
"GOOGLE_OAUTH_CLIENT_ID": "your-client-id",
"GOOGLE_OAUTH_CLIENT_SECRET": "your-secret",
"OAUTHLIB_INSECURE_TRANSPORT": "1"
}
}
}
}
2. Advanced / Cross-Platform Installation
If you’re developing, deploying to servers, or using another MCP-capable client, keep reading.
Instant CLI (uvx)
⚡ Quick Start with uvx ← No installation required!
# Requires Python 3.10+ and uvx
# First, set credentials (see Credential Configuration above)
uvx workspace-mcp --tool-tier core # or --tools gmail drive calendar
Note: Configure OAuth credentials before running. Supports environment variables,
.env
file, orclient_secret.json
.
OAuth 2.1 Support (Multi-User Bearer Token Authentication)
The server includes OAuth 2.1 support for bearer token authentication, enabling multi-user session management. OAuth 2.1 automatically reuses your existing GOOGLE_OAUTH_CLIENT_ID
and GOOGLE_OAUTH_CLIENT_SECRET
credentials - no additional configuration needed!
When to use OAuth 2.1:
- Multiple users accessing the same MCP server instance
- Need for bearer token authentication instead of passing user emails
- Building web applications or APIs on top of the MCP server
- Production environments requiring secure session management
- Browser-based clients requiring CORS support
Enabling OAuth 2.1:
To enable OAuth 2.1, set the MCP_ENABLE_OAUTH21
environment variable to true
.
# OAuth 2.1 requires HTTP transport mode
export MCP_ENABLE_OAUTH21=true
uv run main.py --transport streamable-http
If MCP_ENABLE_OAUTH21
is not set to true
, the server will use legacy authentication, which is suitable for clients that do not support OAuth 2.1.
🔐 Innovative CORS Proxy Architecture ← Advanced OAuth 2.1 details
This implementation solves two critical challenges when using Google OAuth in browser environments:
-
Dynamic Client Registration: Google doesn't support OAuth 2.1 dynamic client registration. Our server provides a clever proxy that accepts any client registration request and returns the pre-configured Google OAuth credentials, allowing standards-compliant clients to work seamlessly.
-
CORS Issues: Google's OAuth endpoints don't include CORS headers, blocking browser-based clients. We implement intelligent proxy endpoints that:
- Proxy authorization server discovery requests through
/auth/discovery/authorization-server/{server}
- Proxy token exchange requests through
/oauth2/token
- Add proper CORS headers to all responses
- Maintain security by only proxying to known Google OAuth endpoints
This architecture enables any OAuth 2.1 compliant client to authenticate users through Google, even from browser environments, without requiring changes to the client implementation.
MCP Inspector: No additional configuration needed with desktop OAuth client.
Claude Code Inspector: No additional configuration needed with desktop OAuth client.
VS Code MCP Client Support
🆚 VS Code Configuration ← Setup for VS Code MCP extension
{
"servers": {
"google-workspace": {
"url": "http://localhost:8000/mcp/",
"type": "http"
}
}
}
Reverse Proxy Setup
If you're running the MCP server behind a reverse proxy (nginx, Apache, Cloudflare, etc.), you have two configuration options:
Problem: When behind a reverse proxy, the server constructs OAuth URLs using internal ports (e.g., http://localhost:8000
) but external clients need the public URL (e.g., https://your-domain.com
).
Solution 1: Set WORKSPACE_EXTERNAL_URL
for all OAuth endpoints:
# This configures all OAuth endpoints to use your external URL
export WORKSPACE_EXTERNAL_URL="https://your-domain.com"
Solution 2: Set GOOGLE_OAUTH_REDIRECT_URI
for just the callback:
# This only overrides the OAuth callback URL
export GOOGLE_OAUTH_REDIRECT_URI="https://your-domain.com/oauth2callback"
You also have options for:
| OAUTH_CUSTOM_REDIRECT_URIS
(optional) | Comma-separated list of additional redirect URIs |
| OAUTH_ALLOWED_ORIGINS
(optional) | Comma-separated list of additional CORS origins |
Important:
- Use
WORKSPACE_EXTERNAL_URL
when all OAuth endpoints should use the external URL (recommended for reverse proxy setups) - Use
GOOGLE_OAUTH_REDIRECT_URI
when you only need to override the callback URL - The redirect URI must exactly match what's configured in your Google Cloud Console
- Your reverse proxy must forward OAuth-related requests (
/oauth2callback
,/oauth2/*
,/.well-known/*
) to the MCP server
🚀 Advanced uvx Commands ← More startup options
# Configure credentials first (see Credential Configuration section)
# Start with specific tools only
uvx workspace-mcp --tools gmail drive calendar tasks
# Start with tool tiers (recommended for most users)
uvx workspace-mcp --tool-tier core # Essential tools
uvx workspace-mcp --tool-tier extended # Core + additional features
uvx workspace-mcp --tool-tier complete # All tools
# Start in HTTP mode for debugging
uvx workspace-mcp --transport streamable-http
Requires Python 3.10+ and uvx. The package is available on PyPI.
Development Installation
For development or customization:
git clone https://github.com/taylorwilsdon/google_workspace_mcp.git
cd google_workspace_mcp
uv run main.py
Development Installation (For Contributors):
🔧 Developer Setup JSON ← For contributors & customization
{
"mcpServers": {
"google_workspace": {
"command": "uv",
"args": [
"run",
"--directory",
"/path/to/repo/google_workspace_mcp",
"main.py"
],
"env": {
"GOOGLE_OAUTH_CLIENT_ID": "your-client-id",
"GOOGLE_OAUTH_CLIENT_SECRET": "your-secret",
"OAUTHLIB_INSECURE_TRANSPORT": "1"
}
}
}
}
HTTP Mode (For debugging or web interfaces)
If you need to use HTTP mode with Claude Desktop:
{
"mcpServers": {
"google_workspace": {
"command": "npx",
"args": ["mcp-remote", "http://localhost:8000/mcp"]
}
}
}
Note: Make sure to start the server with --transport streamable-http
when using HTTP mode.
First-Time Authentication
The server uses Google Desktop OAuth for simplified authentication:
- No redirect URIs needed: Desktop OAuth clients handle authentication without complex callback URLs
- Automatic flow: The server manages the entire OAuth process transparently
- Transport-agnostic: Works seamlessly in both stdio and HTTP modes
When calling a tool:
- Server returns authorization URL
- Open URL in browser and authorize
- Google provides an authorization code
- Paste the code when prompted (or it's handled automatically)
- Server completes authentication and retries your request
◆ Development
Project Structure
google_workspace_mcp/
├── auth/ # Authentication system with decorators
├── core/ # MCP server and utilities
├── g{service}/ # Service-specific tools
├── main.py # Server entry point
├── client_secret.json # OAuth credentials (not committed)
└── pyproject.toml # Dependencies
Adding New Tools
from auth.service_decorator import require_google_service
@require_google_service("drive", "drive_read") # Service + scope group
async def your_new_tool(service, param1: str, param2: int = 10):
"""Tool description"""
# service is automatically injected and cached
result = service.files().list().execute()
return result # Return native Python objects
Architecture Highlights
- Service Caching: 30-minute TTL reduces authentication overhead
- Scope Management: Centralized in
SCOPE_GROUPS
for easy maintenance - Error Handling: Native exceptions instead of manual error construction
- Multi-Service Support:
@require_multiple_services()
for complex tools
Credential Store System
The server includes an abstract credential store API and a default backend for managing Google OAuth credentials with support for multiple storage backends:
Features:
- Abstract Interface:
CredentialStore
base class defines standard operations (get, store, delete, list users) - Local File Storage:
LocalDirectoryCredentialStore
implementation stores credentials as JSON files - Configurable Storage: Environment variable
GOOGLE_MCP_CREDENTIALS_DIR
sets storage location - Multi-User Support: Store and manage credentials for multiple Google accounts
- Automatic Directory Creation: Storage directory is created automatically if it doesn't exist
Configuration:
# Optional: Set custom credentials directory
export GOOGLE_MCP_CREDENTIALS_DIR="/path/to/credentials"
# Default locations (if GOOGLE_MCP_CREDENTIALS_DIR not set):
# - ~/.google_workspace_mcp/credentials (if home directory accessible)
# - ./.credentials (fallback)
Usage Example:
from auth.credential_store import get_credential_store
# Get the global credential store instance
store = get_credential_store()
# Store credentials for a user
store.store_credential("user@example.com", credentials)
# Retrieve credentials
creds = store.get_credential("user@example.com")
# List all users with stored credentials
users = store.list_users()
The credential store automatically handles credential serialization, expiry parsing, and provides error handling for storage operations.
⊠ Security
- Credentials: Never commit
.env
,client_secret.json
or the.credentials/
directory to source control! - OAuth Callback: Uses
http://localhost:8000/oauth2callback
for development (requiresOAUTHLIB_INSECURE_TRANSPORT=1
) - Transport-Aware Callbacks: Stdio mode starts a minimal HTTP server only for OAuth, ensuring callbacks work in all modes
- Production: Use HTTPS & OAuth 2.1 and configure accordingly
- Network Exposure: Consider authentication when using
mcpo
over networks - Scope Minimization: Tools request only necessary permissions
◆ Integration with Open WebUI
◆ Open WebUI Integration ← Connect to Open WebUI as tool provider
▶ Instant Start (No Config)
|
◆ Manual Configuration
|
≡ Configure Open WebUI
- Navigate to Settings → Connections → Tools
- Click Add Tool and enter:
- Server URL:
http://localhost:8001/google_workspace
- API Key: Your mcpo
--api-key
(if set)
- Server URL:
- Save - Google Workspace tools are now available!
≡ License
MIT License - see LICENSE
file for details.