mcp-google-apps-script

# <img src="./assets/a1-logo.svg" alt="A1" width="40"> Google Apps Script MCP

**English** | [Русский](./README.ru.md)

[![npm](https://img.shields.io/npm/v/mcp-google-apps-script)](https://www.npmjs.com/package/mcp-google-apps-script)
[![Glama](https://glama.ai/mcp/servers/A1-x-Tech/mcp-google-apps-script/badges/score.svg)](https://glama.ai/mcp/servers/A1-x-Tech/mcp-google-apps-script)
[![CI](https://github.com/A1-x-Tech/mcp-google-apps-script/actions/workflows/ci.yml/badge.svg)](https://github.com/A1-x-Tech/mcp-google-apps-script/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

**A1 Google Apps Script MCP** lets an AI app write and operate Google Apps Script in plain language. Create a script project, read and edit its code, snapshot versions, manage deployments, run functions and read the execution history.

It uses the Google Apps Script API with your Google account. It distinguishes the editable HEAD code from immutable versions and makes the limits of the Apps Script API explicit instead of implying that every scripting task is possible.

- **19 tools.** Create standalone and bound projects, read and update code files, snapshot immutable versions, manage deployments, run functions, and inspect execution history and metrics.
- **Connects from the conversation.** Say "connect Google Apps Script": the server walks you through the OAuth client, catches Google's redirect on `127.0.0.1` with PKCE and keeps the tokens itself — no config files, no restart.
- **Versions are immutable.** A version snapshots HEAD and can never be edited or deleted; deployments point at versions, so you ship and roll back without changing a URL.
- **The manifest always survives.** Merge mode keeps the `appsscript` manifest and every file you did not mention; replace mode refuses a file set without the manifest before any network traffic.
- **Keep your scriptId.** The API cannot list projects and cannot delete them — the `scriptId` returned by `create_project` is the only handle.
- **Minimal Google scopes.** Each operation names its own scope (`script.projects`, `script.deployments`, `script.processes`, `script.metrics`); request only what your tasks need.

Start with a read-only question:

> Show me the files in my report script and which functions failed this week.

[Connect the server](#quick-start) · [Explore use cases](#what-you-can-ask-it-to-do) · [Open technical documentation](#technical-documentation)

---

## See it work in a minute

> **You:** Show the code and the recent runs of my report script.
>
> **Assistant:** Shows every file with its source and the execution history — which functions ran, when, and which failed. Nothing changes.
>
> **You:** Add a `formatDate` helper to the Utils file and keep everything else as is.
>
> **Assistant:** Shows the proposed source and confirms that merge mode leaves the other files untouched, then asks for confirmation before writing.
>
> **You:** Confirm.
>
> **Assistant:** Writes the file to HEAD. It does not create a version, redeploy or run anything unless you ask separately.

## Contents

- [Quick start](#quick-start)
- [What you can ask it to do](#what-you-can-ask-it-to-do)
- [How a project changes](#how-a-project-changes)
- [What can change](#what-can-change)
- [Getting access](#getting-access)
- [Configuration](#configuration)
- [Data, limits and background work](#data-limits-and-background-work)
- [Technical documentation](#technical-documentation)
- [Support](#support)

## Quick start

You need Node.js 20+ and a Google account. Credentials are not required at install time — the server connects from the conversation.

1. Add the server to your AI app.
2. Say "connect Google Apps Script": the assistant walks you through [creating the OAuth client and approving access](#getting-access) without editing config files.
3. Ask the read-only question above.

<details open>
<summary><strong>Codex</strong></summary>

<br>

**In the app:** open **Settings → MCP servers**, select **Add server**, choose **STDIO**, enter the command `npx -y mcp-google-apps-script@latest` and environment variables `GOOGLE_APPS_SCRIPT_CLIENT_ID`, `GOOGLE_APPS_SCRIPT_CLIENT_SECRET`, `GOOGLE_APPS_SCRIPT_REFRESH_TOKEN`, then select **Save** and **Restart**.

**From the command line:**

```bash
codex mcp add google-apps-script \
  -- npx -y mcp-google-apps-script@latest
```

```bash
codex mcp list
```

[Codex MCP documentation](https://learn.chatgpt.com/docs/extend/mcp?surface=cli)

</details>

<details>
<summary><strong>Claude Code</strong></summary>

<br>

```bash
claude mcp add \
  --transport stdio --scope user google-apps-script \
  -- npx -y mcp-google-apps-script@latest
```

```bash
claude mcp list
```

[Claude Code MCP documentation](https://code.claude.com/docs/en/mcp)

</details>

<details>
<summary><strong>Claude Desktop</strong></summary>

<br>

The current official path is **Settings → Extensions**. For a custom desktop extension, open **Advanced settings → Extension Developer → Install Extension…**, select a `.mcpb` file and follow the prompts.

This repository currently publishes an npm stdio package and does not contain a `.mcpb` bundle. For Claude Desktop builds that still support local configuration, use the following JSON stdio configuration as a fallback:

```json
{
  "mcpServers": {
    "google-apps-script": {
      "command": "npx",
      "args": ["-y", "mcp-google-apps-script@latest"]
    }
  }
}
```

In those builds, save it to `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS or `%APPDATA%\Claude\claude_desktop_config.json` on Windows.

[Claude Desktop MCP documentation](https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop)

</details>

<details>
<summary><strong>Cursor</strong></summary>

<br>

Add this to `~/.cursor/mcp.json` on macOS/Linux or `%USERPROFILE%\.cursor\mcp.json` on Windows:

```json
{
  "mcpServers": {
    "google-apps-script": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "mcp-google-apps-script@latest"]
    }
  }
}
```

[Cursor MCP documentation](https://cursor.com/docs/mcp)

</details>

<details>
<summary><strong>VS Code</strong></summary>

<br>

Run **MCP: Open User Configuration** and add:

```json
{
  "servers": {
    "google-apps-script": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "mcp-google-apps-script@latest"]
    }
  }
}
```

Check it with **MCP: List Servers**.

[VS Code MCP documentation](https://code.visualstudio.com/docs/agent-customization/mcp-servers)

</details>

## What you can ask it to do

### Inspect a project and its runs

- Show this script's files and explain what each function does.
- Which functions failed this week? Show the execution history for `sendDigest`.
- How many users, executions and failures did this script have over the last 7 days?

### Write and evolve code

- Create a standalone project, or a script bound to a Doc, Sheet, Slides or Form.
- Add a helper function to one file without touching the others.
- Snapshot the current code as a version with a description before we refactor.

### Ship, run and roll back

- Deploy version 4 and show its entry points — web app URL or API-executable config.
- Run `sendDigest` and show the result; if the script throws, show the stack trace.
- Repoint the deployment back to version 3 without changing its URL.

## How a project changes

1. `create_project` creates a **project** — standalone, or bound to a Doc, Sheet, Slides or Form. Keep the returned `scriptId`: the API cannot list projects.
2. Code lives at **HEAD** as files addressed by name without extension. `update_project_content` merges by default — it upserts the files you name and keeps the rest — and only replaces the entire set when asked; the `appsscript` manifest can never be deleted.
3. `create_version` snapshots HEAD as an **immutable version** — no edit, no delete, numbers only grow.
4. A **deployment** exposes a version as a web app or API executable. Updating a deployment repoints it at another version without changing its URL; the automatic `@HEAD` deployment cannot be deleted.

The API cannot delete a project either — that means deleting its Drive file, which this server does not cover. `run_function` requires an API-executable deployment, an OAuth client from the same Cloud project as the script and the script's own scopes on the token; Apps Script stops any execution after 6 minutes. The execution history shows status and timing but no error messages — those live in Cloud Logging or come from re-running the function.

## What can change

| Operation | What happens | Confirmation boundary |
|---|---|---|
| Read a project, its code, versions, runs or metrics | Reads data | No change |
| Create a project | Adds a standalone or bound script project | Changes Google Apps Script |
| Update project files | Overwrites code at HEAD; replace mode swaps the entire file set | Changes a project |
| Create a version | Adds an immutable snapshot that can never be removed | Changes a project |
| Create or update a deployment | Changes what a live URL or API endpoint serves | Changes a project's live behavior |
| Delete a deployment | Permanently breaks the deployment URL | Destructive |
| Run a function | Executes real code with real side effects | Destructive |
| Raw API request | Can call API methods without a dedicated tool | Potentially destructive |

The AI client controls confirmation prompts. The server marks reads, writes and destructive tools so the client can distinguish an inspection from a live change.

## Getting access

Google Apps Script requires OAuth 2.0; an API key is not enough. There are two ways in, and the first one needs no configuration files.

### Connect from the chat (recommended)

Say "connect Google Apps Script" and the assistant runs the flow with you:

1. `setup_instructions` prints the checklist: create or select a Google Cloud p