<!-- mcp-name: io.github.taylorwilsdon/workspace-mcp -->

<div align="center">

<span style="color:#cad8d9">Google Workspace MCP Server</span> <img src="https://github.com/user-attachments/assets/b89524e4-6e6e-49e6-ba77-00d6df0c6e5c" width="80" align="right" />

Full natural language control over Google Calendar, Drive, Gmail, Docs, Sheets, Slides, Forms, Tasks, Contacts, and Chat through all MCP clients, AI assistants and developer tools.

Includes a full featured CLI & Code Mode for use with tools like Claude Code and Codex!

The most feature-complete Google Workspace MCP server, it can do things that Google's own tooling and the built in integrations with Claude and ChatGPT can't even dream of. With Remote OAuth2.1 multi-user support, fine-grained editing tools and the most extensive coverage of any Google Workspace tool in existance, Workspace MCP is in a different class. Offering native OAuth 2.1, stateless mode and external auth server support, it's also the only Workspace MCP you can host for your whole organization centrally & securely!

###### Support for all free Google accounts & Google Workspace plans (Starter, Standard, Plus, Enterprise, Non Profit) with expanded app options like Chat & Spaces. <br/><br /> Interested in a private, managed cloud instance? That can be arranged.

</div>

<p align="center"> <a href="https://workspacemcp.com/docs"> <img src="https://img.shields.io/badge/Read%20the%20Docs-0969DA?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Read the Docs"> </a><br /><a href="https://workspacemcp.com/quick-start"> <img src="https://img.shields.io/badge/Quick%20Start-2EA44F?style=for-the-badge" alt="Quick Start Guide"> </a> </p>

<div align="center"> <a href="https://www.pulsemcp.com/servers/taylorwilsdon-google-workspace"> <img width="375" src="https://github.com/user-attachments/assets/0794ef1a-dc1c-447d-9661-9c704d7acc9d" align="center"/> </a> </div>

<div align="center"> <table> <tr> <td align="center"> <b>⚡ Start</b><br> _{<a href="#quick-start">Quick Start</a> · <a href="#prerequisites">Prerequisites</a><br> <a href="#configuration">Google Cloud</a> · <a href="#-credential-configuration">Credentials</a>} </td> <td align="center"> <b>🧰 Tools</b><br> _{<a href="#-available-tools">All Tools</a> · <a href="#tool-tiers">Tool Tiers</a><br> <a href="#cli">CLI</a> · <a href="#start-the-server">Start Server</a>} </td> <td align="center"> <b>🔌 Connect</b><br> _{<a href="#quick-start--connect-claude-to-google-workspace">Quick Start</a> · <a href="#connect-to-claude-desktop">Claude Desktop</a><br> <a href="#claude-code-mcp-client-support">Claude Code</a> · <a href="#vs-code-mcp-client-support">VS Code</a> · <a href="#connect-to-lm-studio">LM Studio</a>} </td> <td align="center"> <b>🚀 Deploy</b><br> _{<a href="#oauth-21-support-multi-user-bearer-token-authentication">OAuth 2.1</a> · <a href="#stateless-mode-container-friendly">Stateless</a><br> <a href="#external-oauth-21-provider-mode">External OAuth</a> · <a href="#reverse-proxy-setup">Reverse Proxy</a>} </td> <td align="center"> <b>📐 Develop</b><br> _{<a href="#-development">Architecture</a> · <a href="#local-development-setup">Dev Setup</a><br> <a href="#-security">Security</a> · <a href="#-license">License</a>} </td> </tr> </table> </div>

See it in action: <div align="center"> <video width="400" src="https://github.com/user-attachments/assets/a342ebb4-1319-4060-a974-39d202329710"></video> </div>

<span style="color:#adbcbc">Overview</span>

Workspace MCP is the single most complete MCP server, the only that integrates all major Google Workspace services with AI assistants and all agent platforms. The entire toolset is available for CLI usage supporting both local and remote instances.

<span style="color:#adbcbc">Features</span>

12 services &ensp;—&ensp; Gmail · Drive · Calendar · Docs · Sheets · Slides · Forms · Chat · Apps Script · Tasks · Contacts · Search

<table> <tr> <td valign="top" width="50%">

📧 Gmail — Complete email management, end-to-end coverage<br> 📁 Drive — File operations with sharing, permissions, Office files, PDFs & images<br> 📅 Calendar — Full event management with advanced features<br> 📝 Docs — Deep, fine-grained editing, formatting & comments<br> 📊 Sheets — Flexible cell management, formatting & conditional rules<br> 🖼️ Slides — Presentation creation, updates & content manipulation<br> 📋 Forms — Creation, publish settings & response management<br> 💬 Chat — Space management, messaging & reactions

</td> <td valign="top" width="50%">

⚡ Apps Script — Cross-application workflow automation<br> _{&ensp;Projects · deployments · versions · execution · debugging}

✅ Tasks — Task & list management with hierarchy<br> 👤 Contacts — People API with groups & batch operations<br> 🔍 Custom Search — Programmable Search Engine integration

🔐 Authentication & Security<br> _{OAuth 2.0 & 2.1 · auto token refresh · multi-user bearer tokens · transport-aware callbacks · CORS proxy}

</td> </tr> </table>

<span style="color:#adbcbc">Security & Compliance</span>

<table> <tr> <td valign="top" width="50%">

For Security Teams

This server sends no data anywhere except Google's APIs, on behalf of the authenticated user, using your own OAuth client credentials. There is no telemetry, no usage reporting, no analytics, no license server, and no SaaS dependency. The entire data path is: your infrastructure → Google APIs.

• Fully open source — every line is auditable in this repo
• Your OAuth client, your GCP project — credentials never leave your environment
• You control the scopes — read-only, granular per-service permissions, or full access
• You control the network — deploy behind your reverse proxy, in your VPC, on your own terms
• No third-party services — no intermediary servers, no token relays, no hosted backends
• Stateless mode — zero disk writes for locked-down container environments
• Sensitive path blocking — local file reads default to the managed attachment directory, and validate_file_path() still blocks .env* files plus common home-directory credential stores such as ~/.ssh/ and ~/.aws/ even if ALLOWED_FILE_DIRS is broadened

Full dependency tree in pyproject.toml, pinned in uv.lock.

</td> <td valign="top" width="50%">

For Legal & Procurement

This project is MIT licensed — not "open core," not "source available," not "free with a CLA." There is no dual licensing, no commercial tier gating features, and no contributor license agreement.

• Use commercially without restriction — build products, sell services, deploy internally
• Fork, embed, redistribute — MIT requires only attribution
• No CLA — contributions remain under MIT
• No telemetry to disclose — nothing to flag in a privacy review
• No network effects — the server never contacts any endpoint you didn't configure
• Standard dependency licenses — MIT, Apache 2.0, and BSD throughout the dependency chain; no copyleft, no AGPL

The license is 21 lines and says what it means.

</td> </tr> </table>

Quick Start

Set credentials → pick a launch command → connect your client

<div align="center">

💡 New to Workspace MCP? Check out the [Interactive Quick Start Guide →](https://workspacemcp.com/quick-start) with step-by-step setup, screenshots, and troubleshooting tips!

</div>

<table> <tr> <td valign="top" width="50%">

Confidential Client Quick Start

# 1. Credentials
export GOOGLE_OAUTH_CLIENT_ID="..."
export GOOGLE_OAUTH_CLIENT_SECRET="..."

# 2. Launch — pick a tier
uvx workspace-mcp --tool-tier core       # essential tools
uvx workspace-mcp --tool-tier extended   # core + management ops
uvx workspace-mcp --tool-tier complete   # everything

# Or cherry-pick services
uv run main.py --tools gmail drive calendar

</td> <td valign="top" width="50%">

Secretless / Public OAuth 2.1 (PKCE) Quick Start

# 1. Credentials
export MCP_ENABLE_OAUTH21=true
export GOOGLE_OAUTH_CLIENT_ID="..."
export WORKSPACE_MCP_PORT=8000
export GOOGLE_OAUTH_REDIRECT_URI="http://localhost:${WORKSPACE_MCP_PORT}/oauth2callback"
export OAUTHLIB_INSECURE_TRANSPORT=1
# Leave GOOGLE_OAUTH_CLIENT_SECRET unset for public PKCE clients
export FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY="$(openssl rand -hex 32)"

# 2. Launch — OAuth 2.1 requires HTTP transport
uvx workspace-mcp --transport streamable-http --tool-tier core
uvx workspace-mcp --transport streamable-http --tool-tier extended
uvx workspace-mcp --transport streamable-http --tool-tier complete

# Or cherry-pick services
uv run main.py --transport streamable-http --tools gmail drive calendar

</td> </tr> </table>

_{Credential setup → · All launch options → · Tier details →}

<details open> <summary><b>Environment Variable Reference</b></summary> <sub>

&ast;Required for development only. Claude Desktop stores credentials securely in the OS keychain — set them once in the extension pane.

</sub> </details>

Quick Start — Connect Claude to Google Workspace

The recommended setup is to run an instance and connect Claude to it via a Connector. Full instructions at [workspacemcp.com/quick-start](https://workspacemcp.com/quick-start).

<div align="center"> <video width="832" src="https://github.com/user-attachments/assets/83cca4b3-5e94-448b-acb3-6e3a27341d3a"></video> </div>

Prerequisites

Python 3.10+ · [uv/uvx](https://github.com/astral-sh/uv) · Google Cloud Project with OAuth 2.0 credentials

If you want the GCS credential store backend, install the optional dependency first:

uv sync --extra gcs
# or
pip install "workspace-mcp[gcs]"

Configuration

<details open> <summary><b>Google Cloud Setup</b></summary>

1. Create Project — Open Console → → Create new project
2. Create OAuth Credentials — APIs & Services → Credentials → Create Credentials → OAuth Client ID

• Choose Desktop Application for a public PKCE client (no redirect URIs needed) or Web Application for a confidential client
• Download and note your Client ID and, if issued, Client Secret

1. Enable APIs — APIs & Services → Library, then enable each service:

Google Chat needs extra setup. Enabling the API is not enough — you must also configure a Chat app and use a Workspace account. See Chat setup under the tool list.

1. Set Credentials — see Environment Variable Reference above, or:

   export GOOGLE_OAUTH_CLIENT_ID="your-client-id"
   export GOOGLE_OAUTH_CLIENT_SECRET="your-secret"

For public OAuth 2.1 PKCE clients, omit GOOGLE_OAUTH_CLIENT_SECRET and set FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY instead.

_{Full OAuth documentation → · Credential setup details →}

</details>

Google Custom Search Setup

<details open> <summary>◆ <b>Custom Search Configuration</b> _{^{← Enable web search capabilities}}</summary>

<table> <tr> <td width="33%" align="center">

1. Create Search Engine

programmablesearchengine.google.com
/controlpanel/create

→ Configure sites or entire web
→ Note your Engine ID (cx)

_{Open Control Panel →}

</td> <td width="33%" align="center">

2. Get API Key

developers.google.com
/custom-search/v1/overview

→ Create/select project
→ Enable Custom Search API
→ Create credentials (API Key)

_{Get API Key →}

</td> <td width="34%" align="center">

3. Set Variables

export GOOGLE_PSE_API_KEY=\
  "your-api-key"
export GOOGLE_PSE_ENGINE_ID=\
  "your-engine-id"

_{Configure in environment}

</td> </tr> <tr> <td colspan="3">

<details open> <summary>≡ <b>Quick Setup Guide</b> _{^{← Step-by-step instructions}}</summary>

Complete Setup Process:

1. Create Search Engine - Visit the Control Panel

• Choose "Search the entire web" or specify sites
• Copy the Search Engine ID (looks like: 017643444788157684527:6ivsjbpxpqw)

1. Enable API & Get Key - Visit Google Developers Console

• Enable "Custom Search API" in your project
• Create credentials → API Key
• Restrict key to Custom Search API (recommended)

1. Configure Environment - Add to your shell or .env:

   export GOOGLE_PSE_API_KEY="AIzaSy..."
   export GOOGLE_PSE_ENGINE_ID="01764344478..."

≡ Full Documentation →

</details>

</td> </tr> </table>

</details>

Start the Server

📌 Transport Mode Guidance: Use streamable HTTP mode (--transport streamable-http) for all modern MCP clients including Claude Code, VS Code MCP, and MCP Inspector. For Claude Desktop, run an instance and connect via a Connector. Stdio mode is a legacy fallback. For deployments, prefer OAuth 2.1 with stateless mode (MCP_ENABLE_OAUTH21=true, WORKSPACE_MCP_STATELESS_MODE=true) unless you need local attachment or credential storage.

OAuth state safety: Legacy stdio starts a local-only OAuth callback server. In single-user mode only, it may recover a missing Google state parameter by consuming the most recent pending local OAuth state. This fallback is intentionally disabled outside single-user mode because it can cross session boundaries. Do not enable or emulate this behavior in streamable HTTP, hosted, or multi-user deployments; those modes must require an explicit state match.

<details open> <summary>▶ <b>Launch Commands</b> _{^{← Choose your startup mode}}</summary>

<table> <tr> <td width="33%" align="center">

▶ Legacy Mode

uv run main.py

_{⚠️ Stdio mode (incomplete MCP clients only)}

</td> <td width="33%" align="center">

◆ HTTP Mode (Recommended)

export MCP_ENABLE_OAUTH21=true
export GOOGLE_OAUTH_CLIENT_ID="..."
uv run main.py \
  --transport streamable-http

_{✅ Full MCP spec compliance & OAuth 2.1}

</td> <td width="34%" align="center">

@ Single User

uv run main.py \
  --single-user

_{Simplified authentication} _{⚠️ Cannot be used with OAuth 2.1 mode}

</td> </tr> <tr> <td colspan="3">

<details open> <summary>◆ <b>Advanced Options</b> _{^{← Tool selection, tiers & Docker}}</summary>

▶ Selective Tool Loading

# Load specific services only
uv run main.py --tools gmail drive calendar
uv run main.py --tools sheets docs

# Combine with other flags
uv run main.py --single-user --tools gmail

🔒 Read-Only Mode

# Requests only read-only scopes & disables write tools
uv run main.py --read-only

# Combine with specific tools or tiers
uv run main.py --tools gmail drive --read-only
uv run main.py --tool-tier core --read-only

Read-only mode provides secure, restricted access by:

• Requesting only *.readonly OAuth scopes (e.g., gmail.readonly, drive.readonly)
• Automatically filtering out tools that require write permissions at startup
• Allowing read operations: list, get, search, and export across all services

🔐 Granular Permissions

# Per-service permission levels
uv run main.py --permissions gmail:organize drive:readonly

# Combine permissions with tier filtering
uv run main.py --permissions gmail:send drive:full --tool-tier core

Granular permissions mode provides service-by-service scope control:

• Format: service:level (one entry per service)
• Gmail levels: readonly, organize, drafts, send, full (cumulative)
• Tasks levels: readonly, manage, full (cumulative; manage allows create/update/move but denies delete and clear_completed)
• Other services currently support: readonly, full
• --permissions and --read-only are mutually exclusive
• --permissions cannot be combined with --tools; enabled services are determined by the --permissions entries (optionally filtered by --tool-tier)
• With --tool-tier, only tier-matched tools are enabled and only services that have tools in the selected tier are imported

The WORKSPACE_MCP_TOOLS, WORKSPACE_MCP_TOOL_TIER, WORKSPACE_MCP_READ_ONLY, and WORKSPACE_MCP_PERMISSIONS environment variables provide the same controls for plugin and container installs. Empty strings are ignored. Non-empty malformed values fail closed at startup. Explicit CLI flags take precedence over mutually exclusive env vars.

Advanced legacy stdio sidecar

# Optional bridge only for local legacy stdio sessions
WORKSPACE_MCP_HTTP_PORT=8001 uv run main.py
workspace-cli --url http://127.0.0.1:8001/mcp list

The sidecar is disabled unless WORKSPACE_MCP_HTTP_PORT is set. It only exists to bridge local workspace-cli calls into a legacy stdio server. Do not use it for normal Claude Code, VS Code, hosted, or multi-user deployments; use streamable HTTP with OAuth 2.1 instead. When enabled, it validates ports in the 1..65535 range, binds to 127.0.0.1, and logs a warning if the port is already in use while keeping stdio running.

★ Tool Tiers

uv run main.py --tool-tier core      # ● Essential tools only
uv run main.py --tool-tier extended  # ◐ Core + additional
uv run main.py --tool-tier complete  # ○ All available tools

◆ Docker Deployment

docker build -t workspace-mcp .
docker run -p 8000:8000 -v $(pwd):/app \
  -e MCP_ENABLE_OAUTH21=true \
  -e GOOGLE_OAUTH_CLIENT_ID="..." \
  workspace-mcp --transport streamable-http

# With tool selection via environment variables
docker run -e TOOL_TIER=core workspace-mcp
docker run -e TOOLS="gmail drive calendar" workspace-mcp

Available Services: gmail • drive • calendar • docs • sheets • forms • tasks • contacts • chat • search

</details>

</td> </tr> </table>

</details>

CLI

The workspace-cli command lists tools and calls them against a running server — with encrypted, disk-backed OAuth token caching so you only authenticate once. On first run it opens a browser for Google consent; subsequent runs reuse the cached tokens automatically.

Tokens are stored encrypted at ~/.workspace-mcp/cli-tokens/ using a Fernet key auto-generated at ~/.workspace-mcp/.cli-encryption-key.

To use workspace-cli globally, you'll want to start in this repo and run uv tool install .

Once complete, you'll have workspace-cli available globally via workspace-cli

Note: there is a public (but abandoned) pypi package with the same name - do not use uvx, as it will pull the wrong thing.

<details open> <summary>▶ <b>workspace-cli Commands</b> _{^{← Persistent OAuth, no re-auth on every call}}</summary>

<table> <tr> <td width="50%" align="center">

▶ List Tools

uv run workspace-cli list
uv run workspace-cli --url https://custom.server/mcp list

# Or, if installed globally:
workspace-cli list
workspace-cli --url https://custom.server/mcp list

_{View all available tools}

</td> <td width="50%" align="center">

◆ Call a Tool

uv run workspace-cli call search_gmail_messages \
  query="is:unread" max_results=5

_{Execute a tool with key=value arguments}

</td> </tr> </table>

Set URL for remote endpoints with --url or the WORKSPACE_MCP_URL environment variable.

<details open> <summary>≡ <b>Advanced: FastMCP CLI</b> _{^{← inspect, install, discover}}</summary>

The upstream FastMCP CLI is also bundled and provides additional commands for schema inspection, client installation, and editor discovery. Note that fastmcp uses in-memory token storage, so each invocation may re-trigger the OAuth flow.

fastmcp inspect fastmcp_server.py                        # print tools, resources, prompts
fastmcp install claude-code fastmcp_server.py             # one-command client setup
fastmcp install cursor fastmcp_server.py
fastmcp discover                                          # find servers configured in editors

See fastmcp --help or the FastMCP CLI docs for the full command reference.

</details>

</details>

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.

<table> <tr> <td width="65%" valign="top">

#### <span style="color:#72898f">Available Tiers</span>

<span style="color:#2d5b69">●</span> Core (--tool-tier core) Essential tools for everyday tasks. Perfect for light usage with minimal API quotas. Includes search, read, create, and basic modify operations across all services.

<span style="color:#72898f">●</span> Extended (--tool-tier extended) Core functionality plus management tools. Adds labels, folders, batch operations, and advanced search. Ideal for regular usage with moderate API needs.

<span style="color:#adbcbc">●</span> Complete (--tool-tier complete) Full API access including comments, headers/footers, publishing settings, and administrative functions. For power users needing maximum functionality.

</td> <td width="35%" valign="top">

#### <span style="color:#72898f">Important Notes</span>

<span style="color:#72898f">▶</span> Start with `core` and upgrade as needed <span style="color:#72898f">▶</span> Tiers are cumulative – each includes all previous <span style="color:#72898f">▶</span> Mix and match with --tools for specific services <span style="color:#72898f">▶</span> Configuration in core/tool_tiers.yaml <span style="color:#72898f">▶</span> Authentication included in all tiers

</td> </tr> </table>

#### <span style="color:#72898f">Usage Examples</span>

# 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

# Combine tier selection with granular permission levels
uv run main.py --permissions gmail:organize drive:full --tool-tier core

📋 Credential Configuration

<details open> <summary>🔑 <b>OAuth Credentials Setup</b> _{^{← Essential for all installations}}</summary>

<table> <tr> <td width="33%" align="center">

🚀 Environment Variables

export GOOGLE_OAUTH_CLIENT_ID=\
  "your-client-id"
export GOOGLE_OAUTH_CLIENT_SECRET=\
  "your-secret"

_{Best for production}

</td> <td width="33%" align="center">

📁 File-based

# Download & place in project root
client_secret.json

# Or specify custom path
export GOOGLE_CLIENT_SECRET_PATH=\
  /path/to/secret.json

_{Traditional method}

</td> <td width="34%" align="center">

⚡ .env File

cp .env.oauth21 .env
# Edit .env with credentials

_{Best for development}

</td> </tr> <tr> <td colspan="3">

<details open> <summary>📖 <b>Credential Loading Details</b> _{^{← Understanding priority & best practices}}</summary>

Loading Priority

1. Environment variables (export VAR=value)
2. .env file in project root (warning - if you run via uvx rather than uv run from the repo directory, you are spawning a standalone process not associated with your clone of the repo and it will not find your .env file without specifying it directly)
3. client_secret.json via GOOGLE_CLIENT_SECRET_PATH
4. Default client_secret.json in project root

Why Environment Variables?

• ✅ Docker/K8s ready - Native container support
• ✅ Cloud platforms - Heroku, Railway, Vercel
• ✅ CI/CD pipelines - GitHub Actions, Jenkins
• ✅ No secrets in git - Keep credentials secure
• ✅ Easy rotation - Update without code changes

</details>

</td> </tr> </table>

</details>

🧰 Available Tools

Note: All tools support automatic authentication via @require_google_service() decorators with 30-minute service caching.

<div align="center">

📖 Looking for detailed parameters? Visit the [Complete Documentation →](https://workspacemcp.com/docs) for comprehensive tool reference, examples, and API guides!

</div>

#### 📅 Google Calendar _calendar_tools.py

#### 📁 Google Drive _drive_tools.py

#### 📧 Gmail _gmail_tools.py

<details open> <summary><b>📎 Email Attachments</b> _{^{← Send emails with files}}</summary>

Both send_gmail_message and draft_gmail_message support attachments via two methods:

Option 1: File Path (local server only)

attachments=[{"path": "/path/to/report.pdf"}]

Reads file from disk, auto-detects MIME type. Optional filename override.

Option 2: Base64 Content (works everywhere)

attachments=[{
    "filename": "report.pdf",
    "content": "JVBERi0xLjQK...",  # base64-encoded
    "mime_type": "application/pdf"   # optional
}]

⚠️ Centrally Hosted Servers: When the MCP server runs remotely (cloud, shared instance), it cannot access your local filesystem. Use Option 2 with base64-encoded content. Your MCP client must encode files before sending.

</details>

<details open> <summary><b>📥 Downloaded Attachment Storage</b> _{^{← Where downloaded files are saved}}</summary>

When downloading Gmail attachments (get_gmail_attachment_content) or Drive files (get_drive_file_download_url), files are saved to a persistent local directory rather than a temporary folder in the working directory.

Default location: ~/.workspace-mcp/attachments/

Files are saved with their original filename plus a short UUID suffix for uniqueness (e.g., invoice_a1b2c3d4.pdf). In stdio mode, the tool returns the absolute file path for direct filesystem access. In HTTP mode, it returns a download URL via the /attachments/{file_id} endpoint.

To customize the storage directory:

export WORKSPACE_ATTACHMENT_DIR="/path/to/custom/dir"

Saved files expire after 1 hour and are cleaned up automatically.

</details>

#### 📝 Google Docs _docs_tools.py

#### 📊 Google Sheets _sheets_tools.py

#### 🖼️ Google Slides _slides_tools.py

#### 📋 Google Forms _forms_tools.py

#### ✓ Google Tasks _tasks_tools.py

#### 👤 Google Contacts _contacts_tools.py

#### 💬 Google Chat _chat_tools.py

<details> <summary>💬 <b>Chat setup — required before any Chat tool works</b></summary>

Unlike other Workspace services, enabling the Chat API is not enough — the Chat API refuses every request until you configure a Chat app, and it only works with Google Workspace accounts. Two extra steps are required:

1. Configure the Chat app

Enabling chat.googleapis.com alone causes every Chat tool to fail. You must also complete the Configuration tab so the API has an app identity to attach requests to:

• Open Chat API → Configuration (APIs & Services → Enabled APIs → Google Chat API → Configuration)
• Fill in the three required fields under Application info:
• App name — e.g. Workspace MCP (up to 25 characters)
• Avatar URL — any HTTPS URL to a square PNG/JPEG (e.g. https://developers.google.com/chat/images/quickstart-app-avatar.png)
• Description — e.g. Workspace MCP (up to 40 characters)
• Click Save

This server authenticates as the signed-in user (user OAuth), not as a bot. You do not need to enable interactive features, create a service account, or publish the app — the Configuration form above is the only Chat-specific setup required.

2. Use a Google Workspace account

The Chat API is not available to personal `@gmail.com` accounts. Configuring it with one returns:

Google Chat API is only available to Google Workspace users.

Sign in with a Business/Enterprise Google Workspace account (the same account you pass as user_google_email).

The required scopes (chat.spaces.readonly, chat.messages.readonly, chat.messages, chat.spaces) are requested automatically during the OAuth flow — no manual scope configuration is needed.

_{Configure the Chat API → · User authentication →}

</details>

#### 🔍 Google Custom Search _search_tools.py

#### ⚡ Google Apps Script _apps_script_tools.py

<sub>

Tool Tier Legend:<br> <span style="color:#2d5b69">●</span> Core — Essential tools for basic functionality · Minimal API usage · Getting started<br> <span style="color:#72898f">●</span> Extended — Core + additional features · Regular usage · Expanded capabilities<br> <span style="color:#adbcbc">●</span> Complete — All available tools including advanced features · Power users · Full API access

</sub>

Connect to Claude Desktop

The recommended way to use Google Workspace MCP with Claude Desktop is to run a server instance and connect Claude to it via a Connector. This provides proper OAuth flow, multi-user support, and the best experience.

See the [Quick Start Guide](https://workspacemcp.com/quick-start) for setup instructions.

<details> <summary>📝 <b>Legacy: Manual stdio configuration</b> _{^{← For clients without Connector support}}</summary>

⚠️ Note: Stdio mode is a legacy fallback for clients that don't support Connectors. Prefer the Connector-based approach above.

>

OAuth callback caveat: The legacy stdio callback path includes a local recovery fallback for rare Google redirects that omit the state parameter, but only when --single-user is active. That recovery can only be safe in a single-user local process; in HTTP or hosted multi-user scenarios it could consume another user's pending OAuth state. There is no environment variable to enable this globally.

1. Open Claude Desktop Settings → Developer → Edit Config

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

1. 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"
      }
    }
  }
}

</details>

Connect to LM Studio

Add a new MCP server in LM Studio (Settings → MCP Servers) using the same JSON format:

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

<details open> <summary>⚡ <b>Quick Start with uvx</b> _{^{← No installation required!}}</summary>

# 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, or client_secret.json.

</details>

Local Development Setup

<details open> <summary>🛠️ <b>Developer Workflow</b> _{^{← Install deps, lint, and test}}</summary>

# Install everything needed for linting, tests, and release tooling
uv sync --group dev

# Run the same linter that git hooks invoke automatically
uv run ruff check .

# Execute the full test suite (async fixtures require pytest-asyncio)
uv run pytest

• uv sync --group test installs only the testing stack if you need a slimmer environment.
• MCP_ENABLE_OAUTH21=true GOOGLE_OAUTH_CLIENT_ID=... uv run main.py --transport streamable-http launches the HTTP server with your checked-out code for manual verification.
• Ruff is part of the dev group because pre-push hooks call ruff check automatically—run it locally before committing to avoid hook failures.

</details>

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, for confidential clients, `GOOGLE_OAUTH_CLIENT_SECRET` credentials - no additional Google-side configuration needed. Public PKCE clients are also supported: if you omit GOOGLE_OAUTH_CLIENT_SECRET, set FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY explicitly.

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

⚠️ Important: Mutually exclusive authentication modes

OAuth 2.1 mode (MCP_ENABLE_OAUTH21=true) cannot be used together with --single-user or service account mode:

• Single-user mode: For legacy clients that pass user emails in tool calls
• OAuth 2.1 mode: For modern multi-user scenarios with bearer token authentication
• Service account mode: For headless/server-to-server use via domain-wide delegation

Choose one authentication method - combining incompatible modes will result in a startup error.

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 uses legacy authentication. In streamable-http mode, legacy authentication binds to 127.0.0.1 by default to keep cached Google credentials local. Set WORKSPACE_MCP_HOST explicitly only for trusted networks; use OAuth 2.1 for remote or shared HTTP deployments.

Streamable HTTP requests with an Origin header are checked against loopback origins, WORKSPACE_EXTERNAL_URL, and OAUTH_ALLOWED_ORIGINS to reduce DNS-rebinding risk. Non-browser MCP clients that omit Origin are unaffected.

vscode-webview origins: Origins with the vscode-webview:// scheme are scoped per-extension using the authority component (e.g. vscode-webview://publisher.extension). Adding a vscode-webview URI to OAUTH_ALLOWED_ORIGINS permits only the specific extension identified by that authority; other extensions are rejected.

<details open> <summary>🔐 <b>How the FastMCP GoogleProvider handles OAuth</b> _{^{← Advanced OAuth 2.1 details}}</summary>

FastMCP ships a native GoogleProvider that we now rely on directly. It solves the two tricky parts of using Google OAuth with MCP clients:

1. Dynamic Client Registration: Google still doesn't support OAuth 2.1 DCR, but the FastMCP provider exposes the full DCR surface and forwards registrations to Google using your fixed credentials. MCP clients register as usual and the provider hands them your Google client ID and, when configured, client secret under the hood.

1. CORS & Browser Compatibility: The provider includes an OAuth proxy that serves all discovery, authorization, and token endpoints with proper CORS headers. We no longer maintain custom /oauth2/* routes—the provider handles the upstream exchanges securely and advertises the correct metadata to clients.

The result is a leaner server that still enables any OAuth 2.1 compliant client (including browser-based ones) to authenticate through Google without bespoke code.

Restricting DCR client redirect URIs:

By default, any client going through Dynamic Client Registration can declare any redirect_uri. For publicly-exposed deployments, this is a phishing vector — an attacker can register a client with a redirect_uri they control and harvest authorization codes from tricked users. Set WORKSPACE_MCP_ALLOWED_CLIENT_REDIRECT_URIS to a comma-separated allowlist of permitted URIs:

# Public deployment — restrict to Claude's hosted OAuth callbacks
export WORKSPACE_MCP_ALLOWED_CLIENT_REDIRECT_URIS="https://claude.ai/api/mcp/auth_callback,https://claude.com/api/mcp/auth_callback"

# Add Claude Code CLI (loopback redirects on ephemeral ports)
export WORKSPACE_MCP_ALLOWED_CLIENT_REDIRECT_URIS="https://claude.ai/api/mcp/auth_callback,https://claude.com/api/mcp/auth_callback,http://localhost:*/callback,http://127.0.0.1:*/callback"

Patterns use FastMCP's matcher: * wildcards any port or path component; *.example.com matches subdomains. Leaving the variable unset preserves the default DCR behaviour (any URI accepted), which is appropriate for local development but unsafe for public deployments.

</details>

Stateless Mode (Container-Friendly)

The server supports a stateless mode designed for containerized environments where file system writes should be avoided:

Enabling Stateless Mode:

# Stateless mode requires OAuth 2.1 to be enabled
export MCP_ENABLE_OAUTH21=true
export GOOGLE_OAUTH_CLIENT_ID="..."
export WORKSPACE_MCP_STATELESS_MODE=true
uv run main.py --transport streamable-http

Key Features:

• No file system writes: Credentials are never written to disk
• No debug logs: File-based logging is completely disabled
• Memory-only sessions: All tokens stored in memory via OAuth 2.1 session store
• Container-ready: Perfect for Docker, Kubernetes, and serverless deployments
• Token per request: Each request must include a valid Bearer token

Requirements:

• Must be used with MCP_ENABLE_OAUTH21=true
• Incompatible with single-user mode
• Clients must handle OAuth flow and send valid tokens with each request

This mode is ideal for:

• Cloud deployments where persistent storage is unavailable
• Multi-tenant environments requiring strict isolation
• Containerized applications with read-only filesystems
• Serverless functions and ephemeral compute environments

MCP Inspector: No additional configuration needed with desktop OAuth client.

Claude Code: No additional configuration needed with desktop OAuth client.

OAuth Proxy Storage Backends

The server supports pluggable storage backends for OAuth proxy state management via FastMCP 2.13.0+. Choose a backend based on your deployment needs.

Available Backends:

Configuration:

# Memory storage (fast, no persistence)
export WORKSPACE_MCP_OAUTH_PROXY_STORAGE_BACKEND=memory

# Disk storage (persists across restarts)
export WORKSPACE_MCP_OAUTH_PROXY_STORAGE_BACKEND=disk
export WORKSPACE_MCP_OAUTH_PROXY_DISK_DIRECTORY=~/.fastmcp/oauth-proxy

# Valkey/Redis storage (distributed, multi-server)
export WORKSPACE_MCP_OAUTH_PROXY_STORAGE_BACKEND=valkey
export WORKSPACE_MCP_OAUTH_PROXY_VALKEY_HOST=redis.example.com
export WORKSPACE_MCP_OAUTH_PROXY_VALKEY_PORT=6379

Disk support requires workspace-mcp[disk] (or py-key-value-aio[disk]) when installing from source. The official Docker image includes the disk extra by default. Valkey support is optional. Install workspace-mcp[valkey] (or py-key-value-aio[valkey]) only if you enable the Valkey backend. Windows: building valkey-glide from source requires MSVC C++ build tools with C11 support. If you see aws-lc-sys C11 errors, set CFLAGS=/std:c11.

<details open> <summary>🔐 <b>Valkey/Redis Configuration Options</b></summary>

Encryption: Disk and Valkey storage are encrypted with Fernet. The encryption key is derived from FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY if set, otherwise from GOOGLE_OAUTH_CLIENT_SECRET. Public OAuth 2.1 client setups without a client secret must set FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY.

</details>

External OAuth 2.1 Provider Mode

The server supports an external OAuth 2.1 provider mode for scenarios where authentication is handled by an external system. In this mode, the MCP server does not manage the OAuth flow itself but expects valid bearer tokens in the Authorization header of tool calls.

Enabling External OAuth 2.1 Provider Mode:

# External OAuth provider mode requires OAuth 2.1 to be enabled
export MCP_ENABLE_OAUTH21=true
export GOOGLE_OAUTH_CLIENT_ID="..."
export EXTERNAL_OAUTH21_PROVIDER=true
uv run main.py --transport streamable-http

How It Works:

• Protocol-level auth enabled: All MCP requests (including initialize and tools/list) require a valid Bearer token, following the standard OAuth 2.1 flow. Unauthenticated requests receive a 401 with resource metadata pointing to Google's authorization server.
• External OAuth flow: Your external system handles the OAuth flow and obtains Google access tokens (ya29.*)
• Token validation: Server validates bearer tokens by calling Google's userinfo API
• Multi-user support: Each request is authenticated independently based on its bearer token
• Resource metadata discovery: The server serves /.well-known/oauth-protected-resource (RFC 9728) advertising Google as the authorization server and the required scopes

Key Features:

• No local OAuth flow: Server does not provide /authorize, /token, or /register endpoints — only resource metadata
• Bearer token only: All authentication via Authorization: Bearer <token> headers
• Stateless by design: Works seamlessly with WORKSPACE_MCP_STATELESS_MODE=true
• External identity providers: Integrate with your existing authentication infrastructure

Requirements:

• Must be used with MCP_ENABLE_OAUTH21=true
• OAuth client ID still required for token validation; client secret is optional for public clients (GOOGLE_OAUTH_CLIENT_ID, optional GOOGLE_OAUTH_CLIENT_SECRET)
• External system must obtain valid Google OAuth access tokens (ya29.*)
• Each tool call request must include valid bearer token

Use Cases:

• Integrating with existing authentication systems
• Custom OAuth flows managed by your application
• API gateways that handle authentication upstream
• Multi-tenant SaaS applications with centraliz