Skip to content

Repository files navigation

A1 Google Sheets MCP

English | Русский

npm Glama CI License: MIT

A1 Google Sheets MCP lets an AI app work with Google Sheets in plain language. Find a spreadsheet, read its data, write and append rows, shape sheets and formatting, build charts and share the result.

It uses the Google Sheets API with your Google account. It separates reading from writing, keeps destructive operations explicit and makes the limits of the Sheets API clear instead of implying that every spreadsheet task is possible.

  • 26 tools. Search and create spreadsheets, read and write ranges, manage sheets, formatting, data validation, protected ranges, conditional formats, structured tables, charts and access.
  • Connects from the conversation. Say "connect Google Sheets": 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.
  • Writes are deliberate. A write is never replayed after an ambiguous failure — a replayed append would duplicate rows — and destructive tools are marked so your AI client can ask first.
  • Sheets only. Drive is an internal dependency for spreadsheet search and sharing alone; there is no generic Drive tool, and raw_request cannot reach Drive.
  • Minimal Google scopes. spreadsheets covers every Sheets tool; a Drive scope is needed only for spreadsheet search and sharing.

Start with a read-only question:

Find the quarterly budget spreadsheet and summarize what each of its sheets contains.

Connect the server · Explore use cases · Open technical documentation


See it work in a minute

You: Show me the structure of the sales report spreadsheet — its sheets, their sizes and frozen rows.

Assistant: Shows the sheets with their sizes, frozen headers and the objects on them. Nothing changes.

You: Prepare a “March” sheet as a copy of “February” and clear the numbers, keeping the layout.

Assistant: Shows the plan — duplicate the sheet, rename it and clear the data ranges — then asks for confirmation before changing anything.

You: Confirm.

Assistant: Duplicates the sheet and clears the values. Formatting, data validation and frozen rows stay.

Contents

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 Sheets": the assistant walks you through creating the OAuth client and approving access without editing config files.
  3. Ask the read-only question above.
Codex

In the app: open Settings → MCP servers, select Add server, choose STDIO, enter the command npx -y @a1-x-tech/mcp-google-sheets@latest and environment variables GOOGLE_SHEETS_CLIENT_ID, GOOGLE_SHEETS_CLIENT_SECRET, GOOGLE_SHEETS_REFRESH_TOKEN, then select Save and Restart.

From the command line:

codex mcp add google-sheets \
  -- npx -y @a1-x-tech/mcp-google-sheets@latest
codex mcp list

Codex MCP documentation

Claude Code
claude mcp add \
  --transport stdio --scope user google-sheets \
  -- npx -y @a1-x-tech/mcp-google-sheets@latest
claude mcp list

Claude Code MCP documentation

Claude Desktop

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:

{
  "mcpServers": {
    "google-sheets": {
      "command": "npx",
      "args": ["-y", "@a1-x-tech/mcp-google-sheets@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

Cursor

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

{
  "mcpServers": {
    "google-sheets": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@a1-x-tech/mcp-google-sheets@latest"]
    }
  }
}

Cursor MCP documentation

VS Code

Run MCP: Open User Configuration and add:

{
  "servers": {
    "google-sheets": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@a1-x-tech/mcp-google-sheets@latest"]
    }
  }
}

Check it with MCP: List Servers.

VS Code MCP documentation

What you can ask it to do

Find and read data

  • Find the newest spreadsheet with “budget” in the name and show its structure.
  • Read 'Q3'!A1:F50 and summarize the totals.
  • Show the formulas behind the Summary sheet.

Update the numbers

  • Write this table into Sheet1!A1, formulas included.
  • Append today’s figures as a new row of the log.
  • Update several ranges in one batch, or clear a draft range while keeping its formatting.

Shape and present

  • Add a “March” sheet, freeze the header row and make it bold.
  • Highlight negative amounts in red with a conditional format and add borders.
  • Build a column chart of revenue by month on its own sheet.
  • Turn the data into a structured table and add a dropdown with data validation.

Protect and share

  • Protect the totals row so only I can edit it.
  • Give a colleague edit access and everyone else read-only.
  • Show who currently has access to the file.

How a spreadsheet changes

  1. Values tools address cells in A1 notation ('Sheet name'!A1:C10); structural tools (sheets, formatting, rules, tables, charts) address a numeric sheetId with 0-based indexes. get_spreadsheet supplies the ids — sheet titles are not addresses.
  2. A write overwrites its range; append_values adds rows after the last data row; a null cell is skipped, not cleared.
  3. clear_values empties values and formulas but keeps formatting, data validation, notes and merges. There is no undo through the API — deleting a sheet, rows or columns destroys their data.
  4. Batch tools carry several ranges or requests in one call and count once against the quota; a batchUpdate is atomic — all of its requests apply or none do.

Some spreadsheet features have no dedicated tool: merged cells, named ranges, banding, filters, slicers, find-and-replace and gradient conditional-format rules go through raw_request, which is limited to the Sheets API origin. A new spreadsheet lands in the My Drive root — moving it into a folder is not covered, and manage_permissions cannot transfer ownership.

What can change

Operation What happens Confirmation boundary
Read metadata or values Reads structure and cells No change
Create a spreadsheet Adds a file to My Drive Changes Google Sheets
Write, batch-write or append values Overwrites cells or adds rows Changes a spreadsheet
Format, freeze, borders, dimensions, validation, rules, tables, charts Changes presentation, structure and rules Changes a spreadsheet
Clear values or delete a sheet, rows or columns Removes data with no undo through the API Destructive
Manage protected ranges and permissions Changes who can open or edit the file Changes access
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 Sheets 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 Sheets" and the assistant runs the flow with you:

  1. setup_instructions prints the checklist: create or select a Google Cloud project, enable Google Sheets API, configure the consent screen and create a Desktop app OAuth client.
  2. Download that client's JSON ("Download JSON") and give the assistant its pathset_client stores it owner-only. The secret never goes through the conversation.
  3. start_login returns a Google consent link. Open it on this machine and approve; the code comes back to a one-shot listener on 127.0.0.1 (PKCE), never through the chat.
  4. finish_login exchanges the code and saves the tokens to ~/.config/mcp-google-sheets/credentials.json (mode 0600).

The tokens are re-read on every call, so the connection works immediately — no restart of the AI app. auth_status shows what is connected, logout revokes and deletes it.

Environment variables (CI, unattended installs)

  1. Create or select a Google Cloud project and enable the Google Sheets API. Also enable the Google Drive API if you want spreadsheet search and sharing.

  2. Configure the OAuth consent screen and create a Desktop app OAuth client.

  3. Authorize the Google account that owns or can edit the spreadsheets. The OAuth 2.0 Playground can obtain the refresh token when Use your own OAuth credentials is enabled.

  4. Request the minimal scope:

    https://www.googleapis.com/auth/spreadsheets
    

    It covers every Sheets tool. Only search_spreadsheets and manage_permissions need a Drive scope on top: https://www.googleapis.com/auth/drive, or drive.readonly for search alone, or drive.file for files created through this app.

Testing-mode OAuth refresh tokens can expire after seven days. Publish the OAuth app, or use an Internal app in a Workspace domain, when you need long-lived access. Treat the client secret and refresh token as passwords.

Configuration

Every variable is optional — with none of them the server connects from the chat.

Variable Required Description
GOOGLE_SHEETS_CLIENT_ID No* OAuth client ID.
GOOGLE_SHEETS_CLIENT_SECRET No* OAuth client secret.
GOOGLE_SHEETS_REFRESH_TOKEN No* OAuth refresh token.
GOOGLE_SHEETS_ACCESS_TOKEN No* Short-lived (~1 h) alternative to the OAuth trio.
GOOGLE_SHEETS_OAUTH_PORT No Fixed loopback port for the in-chat login; useful over SSH port forwarding.
GOOGLE_SHEETS_API_BASE No Google Sheets API base URL override.
GOOGLE_SHEETS_TIMEOUT_MS No Per-request timeout; default 60000 ms.
GOOGLE_SHEETS_MAX_RETRIES No Temporary-error retries; default 3.

* Provide either the OAuth trio or an access token. Without credentials the server still starts and lists its tools; the first call names the variables to set.

Data, limits and background work

  • Requests go to Google. The local server refreshes Google OAuth tokens and calls the Sheets API — and, for spreadsheet search and sharing only, the Drive API. Its anonymous telemetry contains an installation ID, package version, AI client and platform versions, and tool names — never OAuth tokens, spreadsheet data, tool arguments or prompts. Set ASKADS_TELEMETRY=0 to opt out.
  • Google applies per-minute quotas. The documented limits are 300 reads and 300 writes per minute per project, and 60 of each per user; a batch call counts once however many ranges or requests it carries. A spreadsheet holds at most 10,000,000 cells. On 429, the server uses backoff; reads also retry after network and 5xx errors, while writes are not replayed after an uncertain failure.
  • There is no background polling. The server runs only when called. If your AI app supports scheduled tasks, it can check a spreadsheet periodically.

Technical documentation

Support

Found a bug or need a scenario? Create an issue or write in Telegram.


Две Моны дают пять

You made it to the end!

About

MCP server for the Google Sheets API — search spreadsheets, read and write ranges, manage sheets, formatting, validation, protected ranges, tables, charts and sharing. For Claude, Cursor, Codex and ot

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages