
Google Workspace
β 2,800from taylorwilsdon
Integrates Google Workspace services like Calendar, Drive, and Gmail with AI assistants.
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 ifALLOWED_FILE_DIRSis 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.
π§° 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.
- 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 β
π 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
update_script_content Core Update or create script files
run_script_function Core Execute function with parameters
list_deployments Extended List all project deployments
manage_deployment Extended Create, update, or delete script deployments
list_script_processes Extended View recent executions and status
Tool Tier Legend: β Core β Essential tools for basic functionality Β· Minimal API usage Β· Getting started β Extended β Core + additional features Β· Regular usage Β· Expanded capabilities β Complete β All available tools including advanced features Β· Power users Β· Full API access
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 for setup instructions.
π Legacy: Manual stdio configuration** β For clients without Connector support ** β οΈ 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.
Open Claude Desktop Settings β Developer β Edit Config
-
macOS :
~/Library/Application Support/Claude/claude_desktop_config.json -
Windows :
%APPDATA%\Claude\claude_desktop_config.json
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"
}
}
}
}
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)
β‘ 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, or client_secret.json.
Local Development Setup
π οΈ Developer Workflow** β Install deps, lint, and test
# 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 testinstalls only the testing stack if you need a slimmer environment. -
MCP_ENABLE_OAUTH21=true GOOGLE_OAUTH_CLIENT_ID=... uv run main.py --transport streamable-httplaunches the HTTP server with your checked-out code for manual verification. -
Ruff is part of the
devgroup because pre-push hooks callruff checkautomaticallyβrun it locally before committing to avoid hook failures.
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.
π How the FastMCP GoogleProvider handles OAuth** β Advanced OAuth 2.1 details
FastMCP ships a native GoogleProvider that we now rely on directly. It solves the two tricky parts of using Google OAuth with MCP clients:
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.
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.
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:
Backend Best For Persistence Multi-Server Memory Development, testing β β Disk Single-server production β β Valkey/Redis Distributed production β β
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.
π Valkey/Redis Configuration Options**
Variable Default Description
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_HOST localhost Valkey/Redis host
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_PORT 6379 Port (6380 auto-enables TLS)
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_DB 0 Database number
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_USE_TLS auto Enable TLS (auto if port 6380)
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_USERNAME - Authentication username
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_PASSWORD - Authentication password
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_REQUEST_TIMEOUT_MS 5000 Request timeout for remote hosts
WORKSPACE_MCP_OAUTH_PROXY_VALKEY_CONNECTION_TIMEOUT_MS 10000 Connection timeout for remote hosts
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.
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
initializeandtools/list) require a valid Bearer token, following the standard OAuth 2.1 flow. Unauthenticated requests receive a401with 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/registerendpoints β 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, optionalGOOGLE_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 centralized auth
-
Mobile or web apps with their own OAuth implementation
Service Account Mode (Domain-Wide Delegation)
** WARNING: This mode uses Google Workspace domain-wide delegation, which grants the service account the ability to impersonate any user in your domain for the configured scopes. This is powerful and dangerous β do not use this unless you fully understand the security implications. A misconfigured service account with broad scopes can read, modify, and delete data across every user in your organization. Only use this in tightly controlled environments where you know exactly what you're doing.
Service account mode allows the server to authenticate using a Google Cloud service account with domain-wide delegation instead of interactive OAuth flows. The service account impersonates a single configured domain user for all API calls.
When to use service account mode:
-
Headless or unattended environments where no browser is available for OAuth consent
-
Server-to-server integrations that need to act on behalf of a specific domain user
-
CI/CD pipelines or automation scripts
-
Environments where you cannot or do not want to manage per-user OAuth tokens
Enabling Service Account Mode:
# Option 1: Key file on disk
export GOOGLE_SERVICE_ACCOUNT_KEY_FILE="/path/to/service-account-key.json"
export USER_GOOGLE_EMAIL="[emailΒ protected]"
uv run main.py
# Option 2: Inline JSON key (e.g., from a secret manager)
export GOOGLE_SERVICE_ACCOUNT_KEY_JSON='{"type":"service_account","project_id":"...","private_key":"...","client_email":"..."}'
export USER_GOOGLE_EMAIL="[emailΒ protected]"
uv run main.py
Prerequisites:
-
A Google Cloud service account with a JSON key
-
Domain-wide delegation enabled for the service account in your Google Workspace Admin Console (Security β API controls β Domain-wide delegation)
-
The required OAuth scopes authorized for the service account's client ID in the Admin Console
-
USER_GOOGLE_EMAILset to the domain user the service account will impersonate
Incompatibilities:
-
Cannot be combined with
--single-usermode -
Cannot be combined with
MCP_ENABLE_OAUTH21=true -
Only one key source may be provided β set either
GOOGLE_SERVICE_ACCOUNT_KEY_FILEorGOOGLE_SERVICE_ACCOUNT_KEY_JSON, not both
Key Behaviors:
-
The OAuth callback server is not started (no interactive auth needed)
-
Credentials directory permission checks are skipped
-
When a tool call supplies
user_google_email, service account mode uses that email as the domain-wide delegation impersonation subject. -
USER_GOOGLE_EMAILis still required and serves as the fallback when no caller email is provided. -
The service account key is validated at startup (checks for required fields and correct type)
Per-Request Impersonation:
The caller-supplied user_google_email on each tool call is used as the DWD impersonation subject instead of the static USER_GOOGLE_EMAIL. This lets a single server instance act on behalf of multiple domain users.
# Optional: restrict which domains may be impersonated
export DWD_ALLOWED_DOMAINS="corp.com,subsidiary.io"
-
If
DWD_ALLOWED_DOMAINSis set, only emails whose domain appears in the comma-separated list are accepted; all others raise an authentication error. -
If
DWD_ALLOWED_DOMAINSis unset, any email accepted by the service account's delegation scope is allowed.
VS Code MCP Client Support
β Recommended : VS Code MCP extension properly supports the full MCP specification. Always use HTTP transport mode for proper OAuth 2.1 authentication.
π VS Code Configuration** β Setup for VS Code MCP extension
{
"servers": {
"google-workspace": {
"url": "http://localhost:8000/mcp/",
"type": "http"
}
}
}
Note: Make sure to start the server with --transport streamable-http when using VS Code MCP. For remote or shared HTTP endpoints, see the OAuth 2.1 note in the HTTP Mode section .
**
Origin validation : VS Code webview clients send a vscode-webview://<extension-id> origin, which is rejected by default. Add the specific origin to OAUTH_ALLOWED_ORIGINS (e.g. OAUTH_ALLOWED_ORIGINS=vscode-webview://your.extension-id) to permit it. Connections to a localhost/127.0.0.1 URL are allowed without extra configuration.
Claude Code MCP Client Support
β Recommended : Claude Code is a modern MCP client that properly supports the full MCP specification. Always use HTTP transport mode with Claude Code for proper OAuth 2.1 authentication and multi-user support.
π Claude Code Configuration** β Setup for Claude Code MCP support
# Start the server in HTTP mode first
export MCP_ENABLE_OAUTH21=true
export GOOGLE_OAUTH_CLIENT_ID="..."
uv run main.py --transport streamable-http
# Then add to Claude Code
claude mcp add --transport http workspace-mcp http://localhost:8000/mcp
# Optional: install the bundled Claude skill for better Workspace tool routing
mkdir -p ~/.claude/skills
ln -s "$(pwd)/skills/managing-google-workspace" ~/.claude/skills/managing-google-workspace
Or copy skills/managing-google-workspace into ~/.claude/skills/managing-google-workspace if you prefer not to symlink it.
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_U
# 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 calendarBefore it works, you'll need: GOOGLE_OAUTH_CLIENT_IDGOOGLE_OAUTH_CLIENT_SECRETOAUTHLIB_INSECURE_TRANSPORT
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.
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.
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)
2. Get API Key
developers.google.com
/custom-search/v1/overview
β Create/select project
β Enable Custom Search API
β Create credentials (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..."
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
*.readonlyOAuth 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;manageallows create/update/move but deniesdeleteandclear_completed) -
Other services currently support:
readonly,full -
--permissionsand--read-onlyare mutually exclusive -
--permissionscannot be combined with--tools; enabled services are determined by the--permissionsentries (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) -
.envfile in project root (warning - if you run viauvxrather thanuv runfrom 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.jsonviaGOOGLE_CLIENT_SECRET_PATH -
Default
client_secret.jsonin 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
No common issues documented yet. If you hit a problem, the repository's GitHub Issues page is the best place to look.