Skip to main content

Google Sheets

Give agents tools to read, append, update, and clear cell values, and create spreadsheets, rows, and worksheets in Google Sheets through Mastra Connect. Each tool call goes through the Mastra platform, which adds the connection's credential. Your application never stores Google Sheets credentials.

Connect
Direct link to Connect

Before you start, complete the Connect setup to install @mastra/connect and configure your platform project.

Connect an account
Direct link to Connect an account

Run this command from the directory that contains your .env file:

mastra connect add google-sheet

The CLI guides you through Google Sheets' authorization and waits until the connection is active.

Add tools to an agent
Direct link to Add tools to an agent

Pass tools() to the agent and select the google-sheet provider:

src/mastra/agents/google-sheet-agent.ts
import { Agent } from '@mastra/core/agent'
import { tools } from '@mastra/connect'

export const googleSheetAgent = new Agent({
id: 'google-sheet-agent',
name: 'Google Sheets agent',
instructions:
'You help people read, append, update, and clear cell values, and create spreadsheets, rows, and worksheets in Google Sheets.',
model: 'openai/gpt-6-luna',
tools: tools({ providers: ['google-sheet'] }),
})

The agent gets 18 Google Sheets tools, with keys such as google_sheet_append_values_to_spreadsheet. See Google Sheets tools for the full list, and the tools() parameters to restrict tools or require approval before a call runs.

On this page