Includes version control capabilities for managing Google Apps Script projects, supporting feature branch management and safe merging of local and cloud code.
Allows for the automation of Gmail tasks, including processing incoming emails, sending bulk messages, and managing drafts via Google Apps Script.
Provides a bridge for automating various Google Workspace services including Google Drive for file organization and Google Calendar for event management.
Enables AI assistants to create, manage, and deploy Google Apps Script projects with features like local development support, automatic cloud synchronization, and production deployment pipelines.
Integrates with Google Cloud for project configuration, enabling the Google Apps Script API, and managing OAuth 2.0 credentials.
Supports the creation of custom spreadsheet functions, data processing automation, and custom user interface menus within Google Sheets.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@MCP Google Apps Script (GAS) ServerCreate a custom menu in Sheets to highlight duplicates and remove empty rows"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
MCP Google Apps Script Server
π€ + π = β‘
Let AI assistants build and manage Google Apps Script projects for you
π Quick Start β’ π‘ Use Cases β’ π οΈ Features β’ π Docs
π― Why MCP GAS Server?
The Problem
Google Apps Script is powerful for automating Google Workspace, but developing GAS projects traditionally requires:
Switching between local development and the online editor
Manual copy-pasting of code
No proper module system or version control
Limited tooling for testing and deployment
The Solution
MCP GAS Server bridges AI assistants with Google Apps Script, enabling:
AI-Driven Development: Tell Claude/Cursor what to build, and it handles the implementation
Full CommonJS Modules:
require(),module.exports, automatic dependency resolution - write GAS like Node.jsAd-hoc Execution: Run any JavaScript expression instantly - no deployment, no wrapper functions needed
Production Deployment Pipeline: dev β staging β prod workflow with version control, promotion, and rollback
Unix-inspired Interface: Familiar commands (
cat,grep,ls,find,sed) for intuitive GAS project managementLocal Development: Write code locally with full IDE support
Automatic Sync: Bidirectional sync between local files and Google's cloud
Git Integration: Version control for your GAS projects with safe merging
Who Is This For?
Developers who want AI to handle Google Apps Script boilerplate
Teams automating Google Workspace workflows
Non-programmers who need custom Google Sheets functions or automation
Anyone tired of the limitations of Google's online script editor
π‘ Use Cases
What You Can Build
π Custom Spreadsheet Functions: Complex calculations, data processing, API integrations
π§ Email Automation: Process Gmail, send bulk emails, manage drafts
π Calendar Management: Schedule events, sync calendars, automate meeting creation
ποΈ Drive Automation: File organization, backup systems, document generation
π Document Processing: Generate reports, merge documents, extract data
π API Integrations: Connect Google Workspace to external services
π€ Chatbots & Add-ons: Build custom tools for Sheets, Docs, and Forms
Real Examples
// Tell your AI: "Create a function that fetches stock prices and updates my spreadsheet"
// AI will create, deploy, and test the entire solution
// Tell your AI: "Build an expense tracker that categorizes Gmail receipts"
// AI handles OAuth, Gmail API, and spreadsheet integration
// Tell your AI: "Make a custom menu in Sheets for data analysis tools"
// AI creates the UI, functions, and deploys everythingπ Quick Start
β‘ 30-Second Installation
π― Fully Automated (Recommended)
curl -fsSL https://raw.githubusercontent.com/whichguy/mcp_gas/main/install.sh | bash -s -- --autoThis single command: downloads β installs dependencies β builds β configures all IDEs
β OR β
π§ Manual Installation
git clone https://github.com/whichguy/mcp_gas.git && cd mcp_gas && ./install.shClone first, then run installer with more control
Prerequisites
Requirement | Why Needed | How to Get | Auto-Checked? |
Git | Clones repository | β Yes | |
Node.js 18+ | Runs the MCP server | β Yes | |
Google Account | Access Google Apps Script | β Manual | |
AI Assistant | Sends commands to server | β Detected |
π― First Project in 2 Minutes
Install (if not already done)
curl -fsSL https://raw.githubusercontent.com/whichguy/mcp_gas/main/install.sh | bashTell your AI assistant:
"Create a Google Apps Script project that adds a custom menu to Google Sheets with options to highlight duplicate values and remove empty rows"
AI handles everything:
β Creates the project
β Writes the code
β Sets up the menu
β Deploys to Google
β Tests the functionality
βοΈ Installation Details
What the Installer Does
The install.sh script handles everything automatically:
π Downloads Repository (if using curl)
π¦ Installs Dependencies (
npm install)π¨ Builds Project (
npm run build)π Detects Your IDEs (checks for 10+ IDEs)
βοΈ Configures Each IDE (updates MCP settings)
π Links to (production build)
Features:
β Idempotent - Safe to run multiple times
πΎ Creates Backups - Before any modifications
π Checks OAuth - Guides you through Google setup
Command-line Options
./install.sh --dry-run # Preview changes without making them
./install.sh --interactive # Choose which IDEs to configure
./install.sh --auto # Non-interactive mode (for CI/CD)
./install.sh --force # Update existing configurations
./install.sh --help # Show detailed usageManual Build (Advanced)
If the installer fails or you need custom setup:
# 1. Clone repository
git clone https://github.com/whichguy/mcp_gas.git
cd mcp_gas
# 2. Install dependencies
npm install
# 3. Build the project
npm run build
# 4. Configure your IDE manually
# Point to: /absolute/path/to/mcp_gas/dist/src/index.jsNote: The server binary is at dist/src/index.js after building, not in the source directory.
Uninstallation
# Remove MCP GAS from all IDEs
./uninstall.sh
# With cleanup options:
./uninstall.sh --cleanup-build # Also remove dist/ and node_modules/
./uninstall.sh --cleanup-backups # Remove all backup files
./uninstall.sh --dry-run # Preview what would be removedπ Google Cloud Setup
One-Time Configuration
Enable Google Apps Script API:
Visit Google Cloud Console
Create or select a project
Search for "Google Apps Script API" and enable it
Create OAuth 2.0 Credentials:
Navigate to APIs & Services β Credentials
Click "Create Credentials" β "OAuth client ID"
Application type: Desktop app
Download JSON and save as
oauth-config.jsonin project root
π₯οΈ Supported IDEs
The MCP GAS Server works with any MCP-compatible client:
IDE/Editor | Platform Support | Configuration File | Notes |
Claude Desktop | macOS, Windows |
| Official Anthropic desktop app |
Claude Code | macOS, Linux |
| Claude's code editor |
Cursor IDE | All platforms |
| AI-powered IDE |
VS Code | All platforms |
| Microsoft's editor |
VS Code Insiders | All platforms |
| Preview version |
VSCodium | All platforms |
| Open-source VS Code |
Zed Editor | macOS, Linux |
| Uses |
Windsurf IDE | All platforms |
| Codeium's AI IDE |
Neovim MCPHub | All platforms |
| Neovim plugin |
Codex CLI | All platforms |
| Uses TOML format |
Claude Desktop
{
"mcpServers": {
"gas": {
"command": "node",
"args": ["/absolute/path/to/mcp_gas/dist/src/index.js"],
"env": {"NODE_ENV": "production"}
}
}
}VS Code
{
"mcpServers": {
"gas": {
"command": "node",
"args": ["/absolute/path/to/mcp_gas/dist/src/index.js"],
"env": {"NODE_ENV": "production"}
}
}
}Zed Editor (uses context_servers)
{
"context_servers": {
"gas": {
"command": {
"path": "node",
"args": ["/absolute/path/to/mcp_gas/dist/src/index.js"]
}
}
}
}Codex CLI (uses TOML)
[mcp_servers.gas]
command = "node"
args = ["/absolute/path/to/mcp_gas/dist/src/index.js"]
[[mcp_servers.gas.env]]
NODE_ENV = "production"π¦ What's Included
π οΈ 50 Specialized Tools
π File Management
ls- List filescat- Read fileswrite- Write filesrm- Delete filesmv- Move filescp- Copy filesmkdir- Create folders
π Search & Edit
grep- Search textfind- Find filesripgrep- Fast searchsed- Find & replace
β‘ Execution
run- Run codeexec- Execute functions
π Git Integration
rsync- Stateless sync (pull/push with dryrun)git_feature- Feature branch managementconfig- Manage sync folder
π Deployment
deploy- Unified deployment management (promote/rollback/status/reset)
π Projects
project_create- New projectproject_set- Set currentproject_list- List all
Smart vs Raw Tools
Smart tools (
cat,write): Automatically handle CommonJS module wrappingRaw tools (
raw_cat,raw_write): Preserve exact file contentChoose based on whether you want automatic module management or full control
π When to Use MCP GAS Server
β Perfect For
Automation Projects: Gmail, Calendar, Drive, Sheets automation
Custom Functions: Complex spreadsheet formulas and data processing
API Integrations: Connecting Google Workspace to external services
Rapid Prototyping: Quick proof-of-concepts and MVPs
Learning GAS: Let AI teach by example
β Not Ideal For
Large Applications: Consider App Engine or Cloud Functions for complex apps
Real-time Systems: GAS has execution time limits (6 minutes)
Heavy Computing: Limited CPU/memory compared to dedicated servers
Sensitive Data: Evaluate security requirements carefully
π οΈ Advanced Features
Git Workflow Integration
// Set up .git/config breadcrumb file first
mcp__gas__write({
scriptId: "...",
path: ".git/config",
content: JSON.stringify({ repository: "https://github.com/...", localPath: "~/my-project" })
})
// Stateless sync: preview then apply
mcp__gas__rsync({ operation: "pull", scriptId: "...", dryrun: true })
mcp__gas__rsync({ operation: "pull", scriptId: "..." })
// Standard git workflow works in sync folder
cd ~/gas-repos/project-xxx
git add . && git commit -m "Update" && git pushModule System
// Write modular code with CommonJS
const utils = require('./utils');
const api = require('./api/client');
function processData() {
const data = api.fetchData();
return utils.transform(data);
}
module.exports = { processData };First Project Example
// Tell your AI assistant:
"Create a Google Apps Script project that calculates Fibonacci numbers"
// The AI will execute:
// 1. Authenticate
await mcp__gas__auth({ mode: "start" });
// 2. Create project
const project = await mcp__gas__project_create({
title: "Fibonacci Calculator"
});
// 3. Add code
await mcp__gas__write({
scriptId: project.scriptId,
path: "fibonacci",
content: `
function fibonacci(n) {
if (n <= 1) return n;
return fibonacci(n - 1) + fibonacci(n - 2);
}
function test() {
Logger.log(fibonacci(10)); // 55
}
module.exports = { fibonacci };
`
});
// 4. Execute
const result = await mcp__gas__run({
scriptId: project.scriptId,
js_statement: "require('fibonacci').fibonacci(10)"
});
// Returns: 55π Quick Command Reference
Filesystem Operations (Unix-inspired)
// Read file contents (auto-unwraps CommonJS)
mcp__gas__cat({ scriptId: "...", path: "utils/helper" })
// List files matching pattern
mcp__gas__ls({ scriptId: "...", path: "utils/*" })
// β‘ RECOMMENDED: High-performance multi-pattern search with ripgrep
mcp__gas__ripgrep({
scriptId: "...",
pattern: "function.*test",
ignoreCase: true,
context: 2
})
// Simple grep (use ripgrep for advanced searches)
mcp__gas__grep({ scriptId: "...", pattern: "function.*test", outputMode: "content" })
// Find files by name pattern
mcp__gas__find({ scriptId: "...", name: "*.test" })
// Find/replace with regex
mcp__gas__sed({
scriptId: "...",
pattern: "console\\.log",
replacement: "Logger.log"
})
// β‘ Advanced ripgrep features (STRONGLY RECOMMENDED over grep)
mcp__gas__ripgrep({
scriptId: "...",
pattern: "TODO|FIXME|HACK", // Multi-pattern OR search
ignoreCase: true, // Case-insensitive
sort: "path", // Alphabetical sorting
trim: true, // Clean whitespace
context: 2, // Show 2 lines of context
showStats: true // Performance statistics
})Ad-hoc Code Execution
// Execute mathematical expressions
mcp__gas__run({ scriptId: "...", js_statement: "Math.PI * 2" })
// Call Google Apps Script services
mcp__gas__run({
scriptId: "...",
js_statement: "DriveApp.getRootFolder().getName()"
})
// Execute project functions with CommonJS
mcp__gas__run({
scriptId: "...",
js_statement: "require('Calculator').fibonacci(10)"
})
// Complex data operations
mcp__gas__run({
scriptId: "...",
js_statement: `
const data = require('API').fetchData();
const sheet = SpreadsheetApp.create('Report');
sheet.getActiveSheet().getRange(1,1,data.length,3).setValues(data);
return sheet.getId();
`
})CommonJS Module Development
// Write module with automatic CommonJS wrapping
mcp__gas__write({
scriptId: "...",
path: "Calculator",
content: `
function add(a, b) { return a + b; }
function multiply(a, b) { return a * b; }
module.exports = { add, multiply };
`
})
// Use require() in other modules - automatic dependency resolution
mcp__gas__write({
scriptId: "...",
path: "Main",
content: `
const calc = require('Calculator');
const result = calc.add(5, calc.multiply(2, 3));
Logger.log(result); // Logs: 11
`
})
// Read shows clean user code (CommonJS wrapper removed)
mcp__gas__cat({ scriptId: "...", path: "Calculator" })
// Returns user code without _main() wrapperGit Integration
// Create .git/config breadcrumb file
mcp__gas__write({
scriptId: "...",
path: ".git/config",
content: JSON.stringify({
repository: "https://github.com/owner/repo.git",
localPath: "~/my-projects/gas-app"
})
})
// Stateless sync: preview then apply
mcp__gas__rsync({ operation: "pull", scriptId: "...", dryrun: true })
mcp__gas__rsync({ operation: "pull", scriptId: "..." })
// Manage sync folder configuration
mcp__gas__config({
operation: "set",
setting: "sync_folder",
scriptId: "...",
value: "~/my-projects/gas-app"
})π§ Troubleshooting
Common Issues
Problem | Solution |
"Not authenticated" | Run |
"Script not found" | Check scriptId in gas-config.json |
"Module not found" | Ensure proper require() paths and file exists |
"Quota exceeded" | Wait or upgrade Google Cloud quotas |
"Permission denied" | Check OAuth scopes and project permissions |
Debug Mode
# Enable debug logging
DEBUG=mcp:* npm start
# Test installation without changes
./install.sh --dry-run
# Check configuration
cat ~/.claude/claude_desktop_config.json | jq '.mcpServers.gas'π Project Structure
mcp_gas/
βββ src/ # TypeScript source code
β βββ tools/ # ~50 MCP tools
β βββ auth/ # OAuth authentication
β βββ api/ # Google Apps Script API client
β βββ server/ # MCP server implementation
βββ dist/ # Compiled JavaScript (after build)
βββ test/ # Test suites
βββ docs/ # Documentation
βββ install.sh # Automated installer
βββ uninstall.sh # Clean uninstaller
βββ gas-config.json # Project configuration
βββ oauth-config.json # OAuth credentials (create this)π§ͺ Development
Setup
# Clone and install
git clone https://github.com/whichguy/mcp_gas.git
cd mcp_gas
npm install
# Development mode with watch
npm run dev
# Build for production
npm run buildTesting
npm test # Run all tests
npm run test:unit # Unit tests only
npm run test:integration # Integration tests (requires auth)
npm run test:system # System-level tests
npm run test:security # Security validationArchitecture
The MCP GAS Server uses a layered architecture:
MCP Protocol Layer: Handles communication with AI assistants
Tool Layer: ~50 specialized tools for GAS operations
Authentication Layer: OAuth 2.0 PKCE flow with token management
API Client Layer: Google Apps Script API v1 client with rate limiting
File System Layer: Local caching and synchronization
π Documentation
Complete Tool Reference
docs/REFERENCE.md - Complete reference for all 63 tools with capabilities, limitations, and compatibility matrix
Developer Guides
docs/CROSS_TOOL_REFERENCES.md - Strategy for cross-tool references and workflow chaining
docs/SCHEMA_ENHANCEMENTS_SUMMARY.md - Progress tracking for schema improvements
Architecture Guide - System design and internals
Git Integration - Version control workflows
API Documentation - TypeScript API reference
Examples - Sample projects and use cases
Enhanced Tool Schemas
All tools now include:
Script Type Compatibility - Clear indication of standalone vs container-bound support
Limitations - Specific constraints, quotas, and API restrictions
Cross-Tool References - Prerequisites, next steps, alternatives, and error recovery guidance
β‘ Search Tool Preference - ripgrep is STRONGLY RECOMMENDED over grep for all searches (multi-pattern, smart case, context control, better performance)
π€ Contributing
We welcome contributions! See CONTRIBUTING.md for guidelines.
π Report bugs
π‘ Request features
π§ Submit pull requests
π License
MIT - See LICENSE for details.
π Acknowledgments
Built on:
Model Context Protocol by Anthropic
TypeScript, Node.js, and the amazing open-source community
π Ready to supercharge your Google Apps Script development?
Made with β€οΈ by the MCP GAS community