What is google_workspace_mcp?

Control Gmail, Google Calendar, Docs, Sheets, Slides, Chat, Forms, Tasks, Search & Drive with AI - Comprehensive Google Workspace / G Suite MCP Server & CLI Tool. It is open-source on GitHub.

Is google_workspace_mcp free to use?

google_workspace_mcp is open-source under the MIT license, so it is free to use.

What category does google_workspace_mcp belong to?

google_workspace_mcp is listed under mcp-servers in the Claudeers registry of Claude-compatible tools.

Google Workspace MCP Server

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.

Interested in a private, managed cloud instance? That can be arranged.

⚡ Start
_{Quick Start · Prerequisites

Google Cloud · Credentials}

🧰 Tools
_{All Tools · Tool Tiers

CLI · Start Server}

🔌 Connect
_{Quick Start · Claude Desktop

Claude Code · VS Code · LM Studio}

🚀 Deploy
_{OAuth 2.1 · Stateless

External OAuth · Reverse Proxy}

📐 Develop
_{Architecture · Dev Setup

Security · License}

See it in action:

Overview

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.

Features

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

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

⚡ Apps Script — Cross-application workflow automation
_{Projects · deployments · versions · execution · debugging}

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

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

Security & Compliance

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.

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.

Quick Start

Set credentials → pick a launch command → connect your client

💡 New to Workspace MCP? Check out the Interactive Quick Start Guide → with step-by-step setup, screenshots, and troubleshooting tips!

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

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

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

Environment Variable Reference

_{Variable Purpose
🔐 Authentication
GOOGLE_OAUTH_CLIENT_ID required OAuth client ID from Google Cloud
GOOGLE_OAUTH_CLIENT_SECRET OAuth client secret for confidential clients; optional for public OAuth 2.1 PKCE clients
OAUTHLIB_INSECURE_TRANSPORT required* Set to 1 for development — allows http:// redirect
USER_GOOGLE_EMAIL Default email for single-user auth
GOOGLE_CLIENT_SECRET_PATH Custom path to client_secret.json
GOOGLE_MCP_CREDENTIALS_DIR Credential directory — default ~/.google_workspace_mcp/credentials
🖥️ Server
WORKSPACE_MCP_BASE_URI Base server URI (no port) — default http://localhost
WORKSPACE_MCP_PORT Listening port — default 8000. Also controls the stdio-mode OAuth callback port. The PORT env var takes precedence if set.
WORKSPACE_MCP_HOST Bind host — default 0.0.0.0 for OAuth 2.1 HTTP, 127.0.0.1 for legacy streamable HTTP.
WORKSPACE_MCP_TRANSPORT stdio or streamable-http; used when --transport is not passed
WORKSPACE_MCP_HTTP_PORT Advanced legacy-stdio sidecar /mcp port for local workspace-cli access. Disabled when empty. Binds to 127.0.0.1 only and is accessible to local processes.
WORKSPACE_EXTERNAL_URL External URL for reverse proxy setups
WORKSPACE_MCP_BRAND_NAME OAuth 2.1 consent-page server name — default FastMCP's name
WORKSPACE_MCP_BRAND_ICON_URL OAuth 2.1 consent-page logo (hosted URL or data: URI), shown at 64px wide — default FastMCP's logo
WORKSPACE_MCP_BRAND_WEBSITE_URL OAuth 2.1 consent-page website link
WORKSPACE_ATTACHMENT_DIR Downloaded attachments dir and default trusted local attachment directory — default ~/.workspace-mcp/attachments/
WORKSPACE_MCP_URL Remote MCP endpoint URL for CLI
ALLOWED_FILE_DIRS Colon-separated allowlist for local file reads
🧰 Tool Selection
WORKSPACE_MCP_TOOLS Comma-separated services, e.g. gmail,drive,calendar; empty means all services
WORKSPACE_MCP_TOOL_TIER core, extended, or complete; empty means all tools
WORKSPACE_MCP_READ_ONLY true, 1, or yes to request read-only scopes and filter write tools
WORKSPACE_MCP_PERMISSIONS Space-separated service:level entries, e.g. gmail:send drive:readonly; mutually exclusive with tools and read-only
🔑 OAuth 2.1 & Multi-User
MCP_ENABLE_OAUTH21 true to enable OAuth 2.1 multi-user support. Required for remote or shared HTTP endpoints (--transport streamable-http); optional for local-only legacy HTTP, which binds to 127.0.0.1 by default.
EXTERNAL_OAUTH21_PROVIDER true for external OAuth flow with bearer tokens
WORKSPACE_MCP_STATELESS_MODE true for stateless container-friendly operation
WORKSPACE_MCP_LOG_DIR Directory for mcp_server_debug.log — defaults to ~/.google_workspace_mcp/logs
GOOGLE_OAUTH_REDIRECT_URI Override OAuth callback URL — default auto-constructed
OAUTH_CUSTOM_REDIRECT_URIS Comma-separated additional redirect URIs
OAUTH_ALLOWED_ORIGINS Comma-separated additional CORS origins
WORKSPACE_MCP_OAUTH_PROXY_STORAGE_BACKEND memory, disk, or valkey — see storage backends
FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY Custom encryption key for OAuth proxy storage; required for public OAuth 2.1 clients when GOOGLE_OAUTH_CLIENT_SECRET is omitted
WORKSPACE_MCP_ALLOWED_CLIENT_REDIRECT_URIS Comma-separated allowlist of redirect URIs that dynamically-registered OAuth clients may use. Default is unset (any URI permitted, per DCR). Supports FastMCP's glob patterns (*, *.example.com)
🗄️ Credential Store
WORKSPACE_MCP_CREDENTIAL_STORE_BACKEND local_directory (default) or gcs — see credential store system
WORKSPACE_MCP_CREDENTIALS_DIR Directory for the local_directory backend
GOOGLE_MCP_CREDENTIALS_DIR Backward-compatible alias for WORKSPACE_MCP_CREDENTIALS_DIR
WORKSPACE_MCP_GCS_BUCKET Required when backend is gcs — GCS bucket name
WORKSPACE_MCP_GCS_PREFIX Optional object-name prefix for the gcs backend
WORKSPACE_MCP_GCS_REQUIRE_CMEK true to require a bucket default KMS key at startup (fails fast if unset)
🔧 Service Account
GOOGLE_SERVICE_ACCOUNT_KEY_FILE Path to service account JSON key file (domain-wide delegation)
GOOGLE_SERVICE_ACCOUNT_KEY_JSON Inline service account JSON key (alternative to file)
DWD_ALLOWED_DOMAINS Comma-separated domain allowlist for per-request impersonation (optional)
🔍 Custom Search
GOOGLE_PSE_API_KEY API key for Programmable Search Engine
GOOGLE_PSE_ENGINE_ID Search Engine ID for PSE
*Required for development only. Claude Desktop stores credentials securely in the OS keychain — set them once in the extension pane.}

Variable		Purpose
🔐 Authentication
`GOOGLE_OAUTH_CLIENT_ID`	required	OAuth client ID from Google Cloud
`GOOGLE_OAUTH_CLIENT_SECRET`		OAuth client secret for confidential clients; optional for public OAuth 2.1 PKCE clients
`OAUTHLIB_INSECURE_TRANSPORT`	required*	Set to `1` for development — allows `http://` redirect
`USER_GOOGLE_EMAIL`		Default email for single-user auth
`GOOGLE_CLIENT_SECRET_PATH`		Custom path to `client_secret.json`
`GOOGLE_MCP_CREDENTIALS_DIR`		Credential directory — default `~/.google_workspace_mcp/credentials`
🖥️ Server
`WORKSPACE_MCP_BASE_URI`		Base server URI (no port) — default `http://localhost`
`WORKSPACE_MCP_PORT`		Listening port — default `8000`. Also controls the stdio-mode OAuth callback port. The `PORT` env var takes precedence if set.
`WORKSPACE_MCP_HOST`		Bind host — default `0.0.0.0` for OAuth 2.1 HTTP, `127.0.0.1` for legacy streamable HTTP.
`WORKSPACE_MCP_TRANSPORT`		`stdio` or `streamable-http`; used when `--transport` is not passed
`WORKSPACE_MCP_HTTP_PORT`		Advanced legacy-stdio sidecar `/mcp` port for local `workspace-cli` access. Disabled when empty. Binds to `127.0.0.1` only and is accessible to local processes.
`WORKSPACE_EXTERNAL_URL`		External URL for reverse proxy setups
`WORKSPACE_MCP_BRAND_NAME`		OAuth 2.1 consent-page server name — default FastMCP's name
`WORKSPACE_MCP_BRAND_ICON_URL`		OAuth 2.1 consent-page logo (hosted URL or `data:` URI), shown at 64px wide — default FastMCP's logo
`WORKSPACE_MCP_BRAND_WEBSITE_URL`		OAuth 2.1 consent-page website link
`WORKSPACE_ATTACHMENT_DIR`		Downloaded attachments dir and default trusted local attachment directory — default `~/.workspace-mcp/attachments/`
`WORKSPACE_MCP_URL`		Remote MCP endpoint URL for CLI
`ALLOWED_FILE_DIRS`		Colon-separated allowlist for local file reads
🧰 Tool Selection
`WORKSPACE_MCP_TOOLS`		Comma-separated services, e.g. `gmail,drive,calendar`; empty means all services
`WORKSPACE_MCP_TOOL_TIER`		`core`, `extended`, or `complete`; empty means all tools
`WORKSPACE_MCP_READ_ONLY`		`true`, `1`, or `yes` to request read-only scopes and filter write tools
`WORKSPACE_MCP_PERMISSIONS`		Space-separated `service:level` entries, e.g. `gmail:send drive:readonly`; mutually exclusive with tools and read-only
🔑 OAuth 2.1 & Multi-User
`MCP_ENABLE_OAUTH21`		`true` to enable OAuth 2.1 multi-user support. Required for remote or shared HTTP endpoints (`--transport streamable-http`); optional for local-only legacy HTTP, which binds to `127.0.0.1` by default.
`EXTERNAL_OAUTH21_PROVIDER`		`true` for external OAuth flow with bearer tokens
`WORKSPACE_MCP_STATELESS_MODE`		`true` for stateless container-friendly operation
`WORKSPACE_MCP_LOG_DIR`		Directory for `mcp_server_debug.log` — defaults to `~/.google_workspace_mcp/logs`
`GOOGLE_OAUTH_REDIRECT_URI`		Override OAuth callback URL — default auto-constructed
`OAUTH_CUSTOM_REDIRECT_URIS`		Comma-separated additional redirect URIs
`OAUTH_ALLOWED_ORIGINS`		Comma-separated additional CORS origins
`WORKSPACE_MCP_OAUTH_PROXY_STORAGE_BACKEND`		`memory`, `disk`, or `valkey` — see storage backends
`FASTMCP_SERVER_AUTH_GOOGLE_JWT_SIGNING_KEY`		Custom encryption key for OAuth proxy storage; required for public OAuth 2.1 clients when `GOOGLE_OAUTH_CLIENT_SECRET` is omitted
`WORKSPACE_MCP_ALLOWED_CLIENT_REDIRECT_URIS`		Comma-separated allowlist of redirect URIs that dynamically-registered OAuth clients may use. Default is unset (any URI permitted, per DCR). Supports FastMCP's glob patterns (``, `.example.com`)
🗄️ Credential Store
`WORKSPACE_MCP_CREDENTIAL_STORE_BACKEND`		`local_directory` (default) or `gcs` — see credential store system
`WORKSPACE_MCP_CREDENTIALS_DIR`		Directory for the `local_directory` backend
`GOOGLE_MCP_CREDENTIALS_DIR`		Backward-compatible alias for `WORKSPACE_MCP_CREDENTIALS_DIR`
`WORKSPACE_MCP_GCS_BUCKET`		Required when backend is `gcs` — GCS bucket name
`WORKSPACE_MCP_GCS_PREFIX`		Optional object-name prefix for the `gcs` backend
`WORKSPACE_MCP_GCS_REQUIRE_CMEK`		`true` to require a bucket default KMS key at startup (fails fast if unset)
🔧 Service Account
`GOOGLE_SERVICE_ACCOUNT_KEY_FILE`		Path to service account JSON key file (domain-wide delegation)
`GOOGLE_SERVICE_ACCOUNT_KEY_JSON`		Inline service account JSON key (alternative to file)
`DWD_ALLOWED_DOMAINS`		Comma-separated domain allowlist for per-request impersonation (optional)
🔍 Custom Search
`GOOGLE_PSE_API_KEY`		API key for Programmable Search Engine
`GOOGLE_PSE_ENGINE_ID`		Search Engine ID for PSE

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.

Prerequisites

Python 3.10+ · uv/uvx · 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

Google Cloud Setup

Create Project — Open Console → → Create new project
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
Enable APIs — APIs & Services → Library, then enable each service:

Calendar Drive Gmail Docs
Sheets Slides Forms Tasks
Chat People Custom Search Apps Script

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.
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.


Calendar	Drive	Gmail	Docs
Sheets	Slides	Forms	Tasks
Chat	People	Custom Search	Apps Script

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

Google Custom Search Setup

◆ Custom Search Configuration _{^{← Enable web search capabilities}}

1. Create Search Engine

programmablesearchengine.google.com
/controlpanel/create

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

_{Open Control Panel →}

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 →}

3. Set Variables

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

_{Configure in environment}

≡ Quick Setup Guide _{^{← Step-by-step instructions}}

Complete Setup Process:

Create Search Engine - Visit the Control Panel
- Choose "Search the entire web" or specify sites
- Copy the Search Engine ID (looks like: 017643444788157684527:6ivsjbpxpqw)
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)

Configure Environment - Add to your shell or .env:

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

≡ Full Documentation →

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.

▶ Launch Commands _{^{← Choose your startup mode}}

▶ Legacy Mode

uv run main.py

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

◆ 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}

@ Single User

uv run main.py \
  --single-user

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

◆ Advanced Options _{^{← Tool selection, tiers & Docker}}

▶ 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

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.

▶ workspace-cli Commands _{^{← Persistent OAuth, no re-auth on every call}}

▶ 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}

◆ Call a Tool

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

_{Execute a tool with key=value arguments}

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

≡ Advanced: FastMCP CLI _{^{← inspect, install, discover}}

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.

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 (--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.

● 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.

● Complete (--tool-tier complete) Full API access including comments, headers/footers, publishing settings, and administrative functions. For power users needing maximum functionality.

Important Notes

▶ Start with core and upgrade as needed ▶ Tiers are cumulative – each includes all previous ▶ Mix and match with --tools for specific services ▶ Configuration in core/tool_tiers.yaml ▶ Authentication included in all tiers

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

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

📋 Credential Configuration

🔑 OAuth Credentials Setup _{^{← Essential for all installations}}

🚀 Environment Variables

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

_{Best for production}

📁 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}

⚡ .env File

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

_{Best for development}

📖 Credential Loading Details _{^{← Understanding priority & best practices}}

Loading Priority

Environment variables (export VAR=value)
.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)
client_secret.json via GOOGLE_CLIENT_SECRET_PATH
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

🧰 Available Tools

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

📖 Looking for detailed parameters? Visit the Complete Documentation → for comprehensive tool reference, examples, and API guides!

📅 Google Calendar _{calendar_tools.py}

_Tool	_Tier	_Description
_{list_calendars}	_Core	_{List accessible calendars}
_{get_events}	_Core	_{Retrieve events with time range filtering}
_{manage_event}	_Core	_{Create, update, or delete calendar events}
_{create_calendar}	_Extended	_{Create a new secondary Google Calendar}
_{query_freebusy}	_Extended	_{Query free/busy information for calendars}
_{manage_out_of_office}	_Extended	_{Create, list, update, or delete Out of Office events}
_{manage_focus_time}	_Extended	_{Create, list, update, or delete Focus Time 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, PDF, image)}
_{get_drive_file_download_url}	_Core	_{Download Drive files to local disk}
_{create_drive_file}	_Core	_{Create files or fetch from URLs}
_{create_drive_folder}	_Core	_{Create empty folders in Drive or shared drives}
_{import_to_google_doc}	_Core	_{Import files (MD, DOCX, HTML, etc.) as Google Docs}
_{import_to_google_slides}	_Core	_{Import presentation files (PPTX, PPT, ODP) as Google Slides}
_{import_to_google_sheets}	_Core	_{Import spreadsheet files (XLSX, CSV, TSV, etc.) as Google Sheets}
_{get_drive_shareable_link}	_Core	_{Get shareable links for a file}
_{list_drive_items}	_Extended	_{List folder contents or shared drives}
_{copy_drive_file}	_Extended	_{Copy existing files (templates) with optional renaming}
_{update_drive_file}	_Extended	_{Update metadata, move files, or replace Google Apps content}
_{manage_drive_access}	_Extended	_{Grant, update, revoke permissions, and transfer ownership}
_{set_drive_file_permissions}	_Extended	_{Set link sharing and file-level sharing settings}
_{get_drive_file_permissions}	_Complete	_{Get file metadata, parents, and permissions}
_{check_drive_file_public_access}	_Complete	_{Check public sharing status}

📧 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}
_{list_gmail_filters}	_Extended	_{List Gmail filters}
_{manage_gmail_label}	_Extended	_{Create/update/delete labels}
_{manage_gmail_filter}	_Extended	_{Create or delete Gmail filters}
_{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	_{Legacy OAuth 2.0 auth (disabled when OAuth 2.1 is enabled)}

📎 Email Attachments _{^{← Send emails with files}}

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.

📥 Downloaded Attachment Storage _{^{← Where downloaded files are saved}}

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.

📝 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	_{Insert, replace, and richly format text with tab/segment targeting, append-to-segment support, advanced typography, and link management}
_{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}
_{update_paragraph_style}	_Extended	_{Apply advanced paragraph styling including headings, spacing, direction, pagination controls, shading, and bulleted/numbered/checkbox lists with nesting}
_{get_doc_as_markdown}	_Extended	_{Export document as formatted Markdown with optional comments}
_{insert_doc_image}	_Complete	_{Insert images from Drive/URLs}
_{update_doc_headers_footers}	_Complete	_{Create or update headers and footers with correct segment-aware writes}
_{batch_update_doc}	_Complete	_{Execute atomic multi-step Docs API operations including named ranges, section breaks, document/section layout, header/footer creation, segment-aware inserts, images, tables, and rich formatting}
_{inspect_doc_structure}	_Complete	_{Analyze document structure, including safe insertion points, tables, section breaks, headers/footers, and named ranges}
_{export_doc_to_pdf}	_Extended	_{Export document to PDF}
_{create_table_with_data}	_Complete	_{Create data tables}
_{debug_table_structure}	_Complete	_{Debug table issues}
_{list_document_comments}	_Complete	_{List all document comments}
_{manage_document_comment}	_Complete	_{Create, reply to, or resolve comments}
_{manage_doc_tab}	_Complete	_{Create, rename, delete, or populate tabs from markdown}

📊 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}
_{format_sheet_range}	_Extended	_{Apply colors, number formats, text wrapping, alignment, bold/italic, font size}
_{list_sheet_tables}	_Extended	_{List structured tables with IDs, names, ranges, and columns}
_{create_sheet}	_Complete	_{Add sheets to existing files}
_{move_sheet_rows}	_Complete	_{Move rows between sheets within a spreadsheet}
_{append_table_rows}	_Complete	_{Append rows to a structured table, auto-extending the table range}
_{list_spreadsheet_comments}	_Complete	_{List all spreadsheet comments}
_{manage_spreadsheet_comment}	_Complete	_{Create, reply to, or resolve comments}
_{manage_conditional_formatting}	_Complete	_{Add, update, or delete conditional formatting rules}

🖼️ 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}
_{list_presentation_comments}	_Complete	_{List all presentation comments}
_{manage_presentation_comment}	_Complete	_{Create, reply to, or 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}
_{batch_update_form}	_Complete	_{Apply batch updates (questions, settings)}

✓ Google Tasks _{tasks_tools.py}

_Tool	_Tier	_Description
_{list_tasks}	_Core	_{List tasks with filtering}
_{get_task}	_Core	_{Retrieve task details}
_{manage_task}	_Core	_{Create, update, delete, or move tasks}
_{list_task_lists}	_Complete	_{List task lists}
_{get_task_list}	_Complete	_{Get task list details}
_{manage_task_list}	_Complete	_{Create, update, delete task lists, or clear completed tasks}

👤 Google Contacts _{contacts_tools.py}

_Tool	_Tier	_Description
_{search_contacts}	_Core	_{Search contacts by name, email, phone}
_{get_contact}	_Core	_{Retrieve detailed contact info}
_{list_contacts}	_Core	_{List contacts with pagination}
_{manage_contact}	_Core	_{Create, update, or delete contacts}
_{list_contact_groups}	_Extended	_{List contact groups/labels}
_{get_contact_group}	_Extended	_{Get group details with members}
_{manage_contacts_batch}	_Complete	_{Batch create, update, or delete contacts}
_{manage_contact_group}	_Complete	_{Create, update, delete groups, or modify membership}

💬 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}
_{create_reaction}	_Core	_{Add emoji reaction to a message}
_{download_chat_attachment}	_Extended	_{Download attachment from a chat message}

💬 Chat setup — required before any Chat tool works

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.

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 →}

🔍 Google Custom Search _{search_tools.py}

_Tool	_Tier	_Description
_{search_custom}	_Core	_{Perform web searches (supports site restrictions via sites parameter)}
_{get_search_engine_info}	_Complete	_{Retrieve search engine metadata}

⚡ Google Apps Script _{apps_script_tools.py}

_Tool	_Tier	_Description
_{list_script_projects}	_Core	_{List accessible Apps Script projects}
_{get_script_project}	_Core	_{Get complete project with all files}
_{get_script_content}	_Core	_{Retrieve specific file content}
_{create_script_project}	_Core	_{Create new standalone or bound project}

…view the full README on GitHub.

google_workspace_mcp

Google Workspace MCP Server

Support for all free Google accounts & Google Workspace plans (Starter, Standard, Plus, Enterprise, Non Profit) with expanded app options like Chat & Spaces.

Interested in a private, managed cloud instance? That can be arranged.

Overview

Features

Security & Compliance

Quick Start

Quick Start — Connect Claude to Google Workspace

Prerequisites

Configuration

Google Custom Search Setup

Start the Server

CLI

Tool Tiers

Available Tiers

Important Notes

Usage Examples

📋 Credential Configuration

🧰 Available Tools

📅 Google Calendar _{calendar_tools.py}

📁 Google Drive _{drive_tools.py}

📧 Gmail _{gmail_tools.py}

📝 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}

🔍 Google Custom Search _{search_tools.py}

⚡ Google Apps Script _{apps_script_tools.py}

// compatibility

// faq

// embed badge

// retro hit counter

// reviews

// guestbook

// related in MCP Servers

// built by

Platforms	cli, api, desktop, web, mobile
Operating systems	—
AI compatibility	claude
License	MIT
Pricing	open-source
Language	Python

Google Workspace MCP Server

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

Overview

Features

Security & Compliance

Quick Start

Quick Start — Connect Claude to Google Workspace

Prerequisites

Configuration

Google Custom Search Setup

Start the Server

CLI

Tool Tiers

Available Tiers

Important Notes

Usage Examples

📋 Credential Configuration

🧰 Available Tools

📅 Google Calendar calendar_tools.py

📁 Google Drive drive_tools.py

📧 Gmail gmail_tools.py

📝 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

🔍 Google Custom Search search_tools.py

⚡ Google Apps Script apps_script_tools.py

// compatibility

// faq

// embed badge

// retro hit counter

// reviews

// guestbook

// related in MCP Servers

// built by

Support for all free Google accounts & Google Workspace plans (Starter, Standard, Plus, Enterprise, Non Profit) with expanded app options like Chat & Spaces.

Interested in a private, managed cloud instance? That can be arranged.

📅 Google Calendar _{calendar_tools.py}

📁 Google Drive _{drive_tools.py}

📧 Gmail _{gmail_tools.py}

📝 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}

🔍 Google Custom Search _{search_tools.py}

⚡ Google Apps Script _{apps_script_tools.py}