Development · MODEL CONTEXT PROTOCOL
aaronsb google workspace mcp
A Model Context Protocol (MCP) server that provides authenticated access to Google Workspace APIs, offering integrated Authentication, Gmail, Calendar, and Drive functionality
WHAT IT CONNECTS
What aaronsb google workspace mcp gives an AI Agent
- Simplified attachment handling with automatic metadata management
- Streamlined email responses focused on essential information
- Robust attachment indexing and retrieval system
- Efficient file management across Gmail and Calendar
- Automatic cleanup of expired attachments
- `list_workspace_accounts` (aliases: list_accounts, get_accounts, show_accounts)
- List all configured Google accounts and authentication status
- Must be called first before other operations
- Validates required API scopes
- Handles multiple account selection
- `authenticate_workspace_account` (aliases: auth_account, add_account, connect_account)
- Add and authenticate Google accounts for API access
- Supports account categorization (work, personal)
- Handles OAuth flow with user interaction
- Manages token refresh automatically
- `remove_workspace_account` (aliases: delete_account, disconnect_account, remove_account)
- Remove Google accounts and associated tokens
- Clean up stored credentials
- `search_workspace_emails` (aliases: search_emails, find_emails, query_emails)
- Advanced email filtering capabilities:
- Sender/recipient filtering
- Subject and content search
- Date range filtering
- Attachment presence
- Label-based filtering
- Complex Gmail query syntax support
- Common search patterns for:
- Meeting emails
- HR/Admin communications
- Team updates
- Newsletters
- `send_workspace_email` (aliases: send_email, send_mail, create_email)
- Send emails with full formatting
- Support for CC/BCC recipients
- Attachment handling
- Email threading support
- `get_workspace_gmail_settings` (aliases: get_gmail_settings, gmail_settings, get_mail_settings)
- Access account settings
- Language preferences
- Signature configuration
- Vacation responder status
- Filter and forwarding rules
- `manage_workspace_draft` (aliases: manage_draft, draft_operation, handle_draft)
- Complete draft CRUD operations:
- Create new drafts
- Read existing drafts
- Update draft content
- Delete drafts
- Send drafts
- Support for:
- New email drafts
- Reply drafts with threading
- Draft modifications
- Draft sending
- `manage_workspace_label` (aliases: manage_label, label_operation, handle_label)
- Full label CRUD operations
- Support for nested labels
- Custom color configuration
- Visibility settings
- `manage_workspace_label_assignment` (aliases: assign_label, modify_message_labels, change_message_labels)
- Apply/remove labels from messages
- Batch label modifications
- System label updates
- `manage_workspace_label_filter` (aliases: manage_filter, handle_filter, filter_operation)
- Create and manage label filters
- Complex filtering criteria:
- Sender/recipient patterns
- Subject/content matching
- Attachment presence
- Message size rules
- Automated actions:
- Label application
- Importance marking
- Read status
- Archiving
- `list_workspace_calendar_events` (aliases: list_events, get_events, show_events)
- List calendar events with filtering
- Date range specification
- Text search within events
- Customizable result limits
- `get_workspace_calendar_event` (aliases: get_event, view_event, show_event)
- Detailed event information
- Attendee status
- Event settings
- `manage_workspace_calendar_event` (aliases: manage_event, update_event, respond_to_event)
- Event response management:
- Accept/Decline invitations
- Mark as tentative
- Propose new times
- Update event times
- Comment support
- Time zone handling
- `create_workspace_calendar_event` (aliases: create_event, new_event, schedule_event)
- Create new calendar events
- Support for:
- Single events
- Recurring events (RRULE format)
- Multiple attendees
- Time zone specification
- Event description
- Conflict checking
- `delete_workspace_calendar_event` (aliases: delete_event, remove_event, cancel_event)
- Delete calendar events
- Notification options for attendees
- `get_workspace_contacts` (aliases: get_contacts, list_contacts, fetch_contacts)
- Retrieve contacts from a Google account
- Support for:
- Basic contact information (names, emails, phones)
- Extended contact details
- Pagination for large contact lists
- Common use cases:
- Contact lookup
- Address book management
- Contact information retrieval
- `list_drive_files` (aliases: list_files, get_files, show_files)
- List files with optional filtering
- Filter by folder
- Custom query support
- Sorting and pagination
- Field selection
- `search_drive_files` (aliases: search_files, find_files, query_files)
- Full text search across file content
- Filter by MIME type
- Filter by folder
- Include/exclude trashed files
- Advanced query options
- `upload_drive_file` (aliases: upload_file, create_file, add_file)
- Upload new files
- Set file metadata
- Specify parent folders
- Support for various file types
- `download_drive_file` (aliases: download_file, get_file_content, fetch_file)
- Download any file type
- Export Google Workspace files
- Format conversion options
- Automatic MIME type handling
- `delete_drive_file` (aliases: delete_file, remove_file, trash_file)
- Delete files and folders
- Clean removal from Drive
- `create_drive_folder` (aliases: create_folder, new_folder, add_folder)
- Create new folders
- Nested folder support
- Parent folder specification
- Folder metadata
- `update_drive_permissions` (aliases: share_file, update_sharing, modify_permissions)
- Update sharing settings
- Multiple permission types:
- User permissions
- Group permissions
- Domain sharing
- Public access
- Various access roles:
- Owner
- Organizer
- File Organizer
- Writer
- Commenter
- Reader
- Discovery settings for public files
- Admin SDK support
- Additional Google services
- **Simplified Mocking**
- Use static mock responses for predictable testing
- Avoid complex end-to-end simulations in unit tests
- Focus on testing one piece of functionality at a time
- Mock external dependencies (OAuth, file system) with simple implementations
- **Test Organization**
- Group tests by functionality (e.g., account operations, file operations)
- Use clear, descriptive test names
- Keep tests focused and isolated
- Reset mocks and modules between tests
- **Mock Management**
- Use jest.resetModules() to ensure clean state
- Re-require modules after mock changes
- Track mock function calls explicitly
- Verify both function calls and results
- **File System Testing**
- Use simple JSON structures
- Focus on data correctness over formatting
- Test error scenarios (missing files, invalid JSON)
- Verify file operations without implementation details
- **Token Handling**
- Mock token validation with static responses
- Test success and failure scenarios separately
- Verify token operations without OAuth complexity
- Focus on account manager's token handling logic
- **Authentication**
- Store credentials securely in MCP settings
- Use minimal required scopes
- Handle token refresh properly
- **Error Handling**
- Check response status
- Handle auth errors appropriately
- Implement proper retries
- **Configuration & Security**
- Each user maintains their own Google Cloud Project
- Configure OAuth credentials in MCP settings
- Secure token storage in ~/.mcp/google-workspace-mcp
- Regular token rotation
- Never commit sensitive files to git
- Use proper file permissions for config directory
- **Local Development Setup**
- Configure OAuth credentials in MCP settings
- Create ~/.mcp/google-workspace-mcp directory
- Keep sensitive tokens out of version control
- Run authentication script for each account
- **Missing Configuration**
- Error: "GOOGLE_CLIENT_ID environment variable is required"
- Solution: Configure the OAuth credentials in your MCP settings file (see docs/API.md for details)
- **Authentication Errors**
- Error: "Invalid OAuth credentials"
- Solution:
- Verify your Google Cloud project is properly configured
- Ensure you've added yourself as a test user in the OAuth consent screen
- Check that both Gmail API and Google Calendar API are enabled
- Verify credentials in MCP settings match your OAuth client configuration
- **Token Issues**
- Error: "Token refresh failed"
- Solution: Remove the account using `remove_workspace_account` and re-authenticate
- Check that your Google Cloud project has the necessary API scopes enabled
- **Directory Structure**
- Error: "Directory not found"
- Solution: Ensure ~/.mcp/google-workspace-mcp exists with proper permissions
- Verify Docker has access to mount the config directory
SECURITY
An MCP listing is not a security review
An MCP server may receive model context, credentials, local files, or permission to call external systems. Review its code, requested environment variables, network behavior, package provenance, and maintenance status before connecting it to an agent.
README
Repository documentation
Give your AI agent real access to Google Workspace — Gmail, Calendar, Drive, Docs, Sheets, Tasks, Meet and Contacts — from one MCP server, across as many accounts as you have.
Search your mail, check your calendar, write a doc, file a task — in conversation, as yourself.
First, you need Google OAuth credentials — the one prerequisite common to every path:
- Go to console.cloud.google.com/apis/credentials
- Create an OAuth 2.0 Client ID, application type Desktop app
- Enable the APIs you want (Gmail, Calendar, Drive, Sheets, Docs, Tasks, Meet — and People API for contacts, which is what Google calls it in the console)
- Keep the Client ID and Client Secret handy — you'll paste them in below
Then pick the path that matches how you work. All three run the same server.
Node 22.12 or newer. (Node 18 and 20 are both end-of-life.)
Download google-workspace-mcp.mcpb from the latest release, then drag it onto the Claude Desktop window, or double-click it.
Claude Desktop opens an install dialog with three fields:
| Field | |
|---|---|
| Google OAuth Client ID | required — from the step above |
| Google OAuth Client Secret | required — from the step above |
| Workspace Directory | optional — where attachments, downloads and exports land. Defaults to ~/.local/share/google-workspace-mcp/workspace/. Give it a dedicated folder — not your home, Documents, Desktop, or a Google Drive folder. |
Paste, hit Save, done. No JSON to edit, no Node to install, no paths to get right — the bundle carries the server and every dependency.
One bundle covers every platform — macOS (Intel and Apple Silicon), Linux (x64 and ARM64), and Windows. There is nothing to choose: the server is pure JavaScript, so there is no platform-specific payload to pick between.
Cross-platform note:
.mcpbfiles install via Claude Desktop's bundled handler. If double-clicking doesn't trigger Claude on your system, drag the file onto the Claude Desktop window instead, or right-click → "Open with…" and pick Claude Desktop (then "always open with" if your OS offers). Behavior varies: macOS usually auto-associates, Windows may need a one-time association, Linux varies by desktop environment.
claude mcp add google-workspace \
-e GOOGLE_CLIENT_ID=your-client-id \
-e GOOGLE_CLIENT_SECRET=your-client-secret \
-- npx -y @aaronsb/google-workspace-mcpThat's it — no file to edit. Verify with /mcp.
Add an entry to the client's MCP config file (for Claude Desktop by hand, that's claude_desktop_config.json; for Claude Code, .mcp.json):
{
"mcpServers": {
"google-workspace": {
"command": "npx",
"args": ["-y", "@aaronsb/google-workspace-mcp"],
"env": {
"GOOGLE_CLIENT_ID": "your-client-id",
"GOOGLE_CLIENT_SECRET": "your-client-secret"
}
}
}
}Or install it globally and point at the binary directly:
npm install -g @aaronsb/google-workspace-mcpflowchart LR
human["🧑 You<br>ask in plain language"]
agent["🤖 Your AI agent<br>Claude Desktop, Claude Code…"]
server["⚙️ This MCP server<br>picks the right account,<br>builds the real request"]
keys[("🔑 Your accounts<br>OAuth tokens, kept<br>on your own machine")]
google["☁️ Google<br>Gmail · Calendar · Drive · Docs<br>Sheets · Tasks · Meet · Contacts"]
human -->|"“what's on my calendar?”"| agent
agent -->|"tool call"| server
server <-->|"which account?"| keys
server -->|"real API call, as you"| google
google -->|"your data"| server
server -->|"shaped for an agent<br>+ what to do next"| agent
agent -->|"an answer"| human
classDef person fill:#475569,color:#ffffff,stroke:#94a3b8
classDef robot fill:#2d7d9a,color:#ffffff,stroke:#4a5568
classDef ours fill:#7c3aed,color:#ffffff,stroke:#8b5cf6
classDef secrets fill:#2d8e5e,color:#ffffff,stroke:#4a5568
classDef external fill:#f6821f,color:#1a1a1a,stroke:#d97706
class human person
class agent robot
class server ours
class keys secrets
class google external
Your credentials never leave your machine. The server holds an OAuth token per account, on your own disk, and calls Google as you — there is no middleman service, no account of ours, nothing to sign up for. Add as many accounts as you like (personal and work, side by side); the server routes each request to the right one.
12 tools across 8 Google services, plus multi-account handling, per-account read-only access, bulk execution, content authoring, and a file sandbox.
| Tool | What It Does |
|---|---|
manage_email |
Gmail — search, read (plain or sanitized HTML), send, reply / reply-all, forward, triage, trash, drafts (list / delete), labels, threads, attachments |
manage_calendar |
Calendar — list, agenda, get, create, quickAdd (natural language), update, delete, calendars, freebusy |
manage_drive |
Drive — search, get, upload, download, copy, rename / move, delete, export, permissions, comments, view images |
manage_sheets |
Sheets — read / write ranges (row-numbered output), append, clear, manage tabs, copy / duplicate / rename |
manage_docs |
Docs — get, create, append, insert text, find-and-replace |
manage_tasks |
Tasks — list / create / update / complete tasks and task lists |
manage_meet |
Meet — create and configure meeting spaces, see who is in a call now, browse past conferences, participants, transcripts, recordings, smart notes |
manage_contacts |
Contacts — look people up in your saved contacts, the addresses you have only corresponded with, and your organization's directory; create, update and delete contacts |
manage_accounts |
Multi-account lifecycle — add accounts, manage credentials and scopes |
manage_scratchpad |
Compose / edit multi-line content (line- or JSON-path-addressed), attach files, send to any target; JSON mode live-syncs to Docs / Sheets |
manage_workspace |
File operations in the workspace sandbox (exchange point for attachments, downloads, exports) |
bulk_operations |
Do many things in one call — chain different operations in sequence with $N.field references, or apply one operation to many resources in a single Google request (queue_operations still works as an alias) |
Every response carries next-steps guidance, so the agent always knows what it can do next.
The useful part isn't any single operation — it's that your agent can string them together.
You ask for one thing. The agent works out that it needs four API calls, in order, each one feeding the next:
sequenceDiagram
autonumber
participant H as 🧑 You
participant A as 🤖 Your agent
participant S as ⚙️ MCP server
participant G as ☁️ Google
H->>A: "file the invoice from Acme<br>and remind me to pay it Friday"
A->>S: find the email
S->>G: search Gmail
G-->>S: the message
S-->>A: found it — and here's what you can do next
A->>S: save the attachment
S->>G: download it
A->>S: put it in Drive
S->>G: upload
A->>S: create a task, due Friday
S->>G: Google Tasks
A-->>H: Done. Invoice filed, task set for Friday.
Two things make this work. Every response tells the agent what it can do next, so it isn't guessing at the next step. And bulk_operations lets it run a whole chain in one call, feeding each result into the next — so "find the invoice, file it, remind me" is a single round trip rather than four.
When the work is the same operation over many things, it can go further and use one Google request for all of them:
bulk_operations { mode: 'batch', tool: 'manage_email', operation: 'trash',
items: ['msg1', 'msg2', 'msg3', … ] }
Two hundred messages trashed in one round trip instead of two hundred. This is narrow on purpose — it works only where Google publishes a method for it, which today is contacts (create, update, delete, get) and Gmail (trash, label changes). Ask for it anywhere else and the answer names the operations that can, and points you back at sequential mode, which works everywhere.
This server exposes 95 operations, reaching 79 of the 257 methods Google publishes across those eight APIs. It is a curated subset on purpose: an agent has to choose among these, and every method it must weigh is one it can pick wrongly. A tool with 257 operations isn't more capable than one with 95 — it's harder to use correctly.
But that judgement was made without you.
→ Browse every method Google publishes
Every method is listed — what it does, whether we expose it, and a Request link that opens a pre-filled issue. The descriptions are Google's own, quoted verbatim, and the page is generated from the same specification the client is built from, so it can't drift from reality.
That page also lists three whole APIs this server doesn't touch yet — Chat, Slides and Forms — for the same reason: not targeted is a decision, not a fact of nature.
A good request names the task, not the method:
"I want the agent to file incoming invoices into a folder automatically."
That can be evaluated. It might turn out an existing operation already does it, or that the right answer is a different method than the one you found. "Expose users.settings.filters.create" is a conclusion, not a case — lead with the problem and let the method follow.
Everything is here. There is no paid tier, no "enterprise" build, no feature held back to sell you later. What you install is what exists.
Open core works by keeping the good part back. The free thing is a lead magnet, and the moment your use gets serious you discover the operation you need lives behind a licence. That model would be especially rotten here: this is a piece of plumbing between you and your own data, using your own Google credentials, running on your own machine. Nothing about that arrangement should have a paywall in the middle of it, and nothing about it needs a vendor.
Apache 2.0 rather than MIT for two concrete reasons:
- An explicit patent grant. Contributors licence their patent claims along with their code, so using this can't become a patent problem later. MIT is silent on patents, which means the question is merely unanswered rather than settled.
- It's safe to adopt at work. Apache 2.0 is on essentially every corporate allow-list. Fork it, vendor it, ship it inside a commercial product — you don't owe anyone anything, and you don't need to ask.
The one obligation is attribution: keep the notices (NOTICE, LICENSE) with the code. That's it.
Through v3.0.0 this project was MIT-licensed, and that history is preserved rather than erased — MIT-era contributions keep their original notice in LICENSE-MIT, and their authors are credited in NOTICE. Apache 2.0 takes back nothing MIT permitted.
Add an account (opens a browser for OAuth):
manage_accounts { "operation": "authenticate" }
Then use any tool with your account email:
manage_email { "operation": "triage", "email": "you@gmail.com" }
manage_calendar { "operation": "agenda", "email": "you@gmail.com" }
manage_drive { "operation": "search", "email": "you@gmail.com", "query": "quarterly report" }
Some accounts should never be written to. Ask for less at consent time and the token itself cannot send, edit or delete — this isn't a rule layered over a broad token:
manage_accounts { "operation": "scopes", "email": "you@gmail.com",
"services": "gmail,drive,contacts", "access": "read" }
Google is asked for the read-only variant of each scope, so ticking every box on the consent screen still yields a read-only token. manage_accounts status reports what each account actually holds.
A write from a read-only account is refused before the request leaves, with the account, the operation, and the way back:
'create' needs write access to contacts. Account you@gmail.com was authorized
read-only for contacts. Re-authorize with manage_accounts {operation:'scopes',
email:'you@gmail.com', services:'contacts', access:'readwrite'}, or use an
account that already has it.
Where a service has no read-only scope, you're told which ones and what they'll still be able to do before the browser opens.
Chain operations with result references — the output of one step feeds the next:
{
"operations": [
{ "tool": "manage_email", "args": { "operation": "search", "email": "you@gmail.com", "query": "from:boss subject:review" }},
{ "tool": "manage_email", "args": { "operation": "read", "email": "you@gmail.com", "messageId": "$0.messageId" }}
]
}Where Google publishes a method for it, the same operation across many resources costs one request:
{
"mode": "batch",
"tool": "manage_contacts",
"operation": "delete",
"email": "you@gmail.com",
"items": ["people/c1", "people/c2", "people/c3"]
}Anything shared by the whole batch goes at the top level; items carry only what differs — a bare id is enough when that's all it is.
Follows the XDG Base Directory Specification:
| Data | Location |
|---|---|
| Account registry | ~/.config/google-workspace-mcp/accounts.json |
| Credentials | ~/.local/share/google-workspace-mcp/credentials/ |
| Workspace (file exchange) | ~/.local/share/google-workspace-mcp/workspace/ |
Credentials are per-account files holding standard OAuth tokens. No secrets are stored in the project directory.
You don't need any of this to use the server. But if you're curious, or you want to add an operation:
The server builds its Google API client from Google's own machine-readable API specifications. Nothing is transcribed by hand, so the surface can't drift from reality, and adding an operation is a YAML edit rather than a code change.
- How it works — the build-time / runtime split, the descriptor, the factory
- API coverage — what's exposed, what isn't, and how to ask for more
- The full API surface — every method Google publishes, plus the three APIs we don't target yet
- Architecture decisions — the ADRs, including why this server owns its Google client outright
Apache License 2.0 — see Why Apache 2.0 above.
COMMUNITY