Skip to content

Guide · Agent skill

How to use the Google Sheets Reader agent skill (gws-sheets-read)

Updated · written with AI from the project's own documentation and checked against our catalogue data

The gws-sheets-read skill teaches an AI agent to pull values out of a Google Sheets spreadsheet using the gws command-line tool. It is aimed at people who want an agent to summarise or analyse numbers stored in a sheet, and at developers who need spreadsheet values in scripts or reports. After this guide you will know what the skill does, how to install it, how to ask for data in plain language, and what it needs to run.

Google Sheets Readergoogleworkspace/cli · Apache-2.0

Quick start

  1. 1Install gws. Install the gws command-line tool (Google Workspace CLI) and authenticate it to your Google account.
  2. 2Get the shared auth skill. Make sure the gws-shared skill exists. If it is missing, run gws generate-skills.
  3. 3Download and unzip the skill. Download the ZIP from this page and unzip it into ~/.claude/skills/ or a project's .claude/skills/ folder.
  4. 4Or upload it in the Claude apps. Go to Settings → Capabilities → Skills and upload the skill.
  5. 5Find your spreadsheet ID and range. Copy the spreadsheet ID from the sheet's URL and decide which range you need, such as Sheet1!A1:D10.
  6. 6Ask in plain language. Request the data with the ID and range, for example asking the agent to summarise Sheet1!A1:D10.

What is an agent skill, and what does this one do?

An agent skill is a folder containing a SKILL.md file that gives an AI agent instructions for one kind of task. This skill covers one task: reading values from a Google Sheets spreadsheet. When you ask the agent for data from a specific sheet or cell range, it runs a read-only gws command and works with the returned values.

The skill does not change the spreadsheet. Writing, editing and formatting are handled by a different skill, gws-sheets.

What you need before installing

The skill cannot work without the gws command-line tool (Google Workspace CLI) installed. Your Google account must also be authenticated for gws. The source points to the shared gws-shared skill for auth setup, global flags and security rules. If that shared skill is missing, the source says to run gws generate-skills to create it.

You also need the spreadsheet ID and the range you want to read. You supply these in your request.

  • gws command-line tool (Google Workspace CLI)
  • Google account authentication configured for gws (see the gws-shared skill)
  • Spreadsheet ID and range supplied by you

Install the gws-sheets-read skill

Download the ZIP from this page and unzip it. The skill ships as a single file, SKILL.md. For a personal setup, place the unzipped skill folder in ~/.claude/skills/. For a single project, place it in that project's .claude/skills/ folder.

You can also upload the skill in the Claude apps under Settings → Capabilities → Skills.

  • Personal: ~/.claude/skills/
  • Project only: .claude/skills/ inside your project folder
  • Claude apps: Settings → Capabilities → Skills, then upload

How to trigger the skill with natural requests

You do not need to name the skill or type a command. Ask for spreadsheet data in plain language and include the spreadsheet ID and the range. The agent uses the skill when your request is about reading values from a sheet.

Give a specific sheet or cell range. Requests like 'Sheet1 rows 1 to 10' are clearer than 'look at my data'. The skill's own examples use a range such as Sheet1!A1:D10 or a whole sheet name such as Sheet1.

  • Read cells A1 to D10 from spreadsheet ID 1AbC... on Sheet1 and total the Amount column.
  • Pull the values from Sheet1 in spreadsheet 1AbC... and tell me which rows have a status of Late.
  • Get the data in Sales!A1:F50 from this spreadsheet and summarise the monthly totals.

Run the underlying command yourself

The skill runs the same command you can run by hand. It takes a spreadsheet ID and a range. Quote the range if it contains spaces or special characters. Passing only a sheet name reads that sheet.

The source lists these flags: --spreadsheet (required, the spreadsheet ID) and --range (required, for example 'Sheet1!A1:B2').

  • --spreadsheet: required, spreadsheet ID
  • --range: required, range to read, e.g. Sheet1!A1:B2
gws sheets +read --spreadsheet ID --range "Sheet1!A1:D10" gws sheets +read --spreadsheet ID --range Sheet1

Safety notes: scripts and network access

This skill runs scripts and uses the network. It calls Google Sheets through the gws tool, using your authenticated Google credentials. Only install it if you are comfortable with the agent reading that spreadsheet.

Do not use it on sensitive spreadsheets you do not want an agent to access. The skill is read-only, so it will not modify the sheet, but reading still exposes the values to the agent's session.

  • Runs scripts: yes
  • Uses network: yes
  • Read-only: the skill never modifies the spreadsheet
  • Credentials: reads go through your gws authentication

Tips for better results

For advanced options that the +read command does not offer, the source suggests using the raw values.get API instead. Check the gws-shared and gws-sheets skills for global flags and the full set of spreadsheet commands.

  • Always include the spreadsheet ID and a specific range.
  • If you see an authentication error, confirm gws is installed and authenticated (see gws-shared).
  • Use gws sheets +read --help to see the command's help text.
gws sheets +read --help

What people use it for

  • Summarise totals or averages from a sales or budget sheet.
  • Find rows that match a condition, such as overdue items in a tracker.
  • Pull a fixed range into a script or report built by a developer.
  • Quick lookups of operational data without opening the browser.

Frequently asked questions

How do I install the gws-sheets-read skill?

Download the ZIP from this page and unzip it into ~/.claude/skills/ for personal use, or into a project's .claude/skills/ folder for one project. You can also upload it in the Claude apps under Settings → Capabilities → Skills.

What are the requirements for gws-sheets-read?

You need the gws command-line tool (Google Workspace CLI), Google account authentication configured for gws, and the spreadsheet ID and range for each request. The skill cannot work without gws.

Can this skill edit or write to my spreadsheet?

No. The skill is read-only and never modifies the spreadsheet. Write and edit commands are in the separate gws-sheets skill.

Is gws-sheets-read free and what is its licence?

The skill is listed under the Apache-2.0 licence. The source does not state pricing, so check the project page for any cost terms.

What do I do if the skill says gws is missing or authentication fails?

Confirm the gws tool is installed and authenticated to your Google account, following the gws-shared skill. If the shared skill is missing, run gws generate-skills to create it.

Does this skill work with other tools besides Google Sheets?

This skill only reads Google Sheets through gws. The source does not describe other spreadsheet services, so for those you would need a different skill or tool.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use this skill if you want an agent to read and analyse values from Google Sheets safely, since it is read-only, and you are comfortable installing the gws CLI and authenticating it. Skip it if you need to write or format sheets, do not have gws set up, or do not want an agent to access a sensitive spreadsheet.

Download the skill