gws-gmail-read

Extract message body and headers from Gmail using message IDs.

googleworkspace/cliUpdated Apr 8, 2026

Works with

Claude CodeCursorClineWindsurfCodexGooseGitHub CopilotZed

0

total installs

0

this week

23.9K

GitHub stars

0

upvotes

Install Skill

Run in your terminal

$npx skills add https://github.com/googleworkspace/cli --skill gws-gmail-read

0

installs

0

this week

23.9K

stars

What it does

  • Reads individual Gmail messages by ID and returns body content in plain text or HTML format

  • Optionally includes message headers (From, To, Subject, Date) in output

  • Supports multiple output formats (text, json) and automatically converts HTML-only messages to plain text

  • Handles multipart messages and base64 decoding; includes dry-run mode for testing requests

Category

AI/ML

Last updated

Apr 8, 2026

Installation Guide

How to use gws-gmail-read on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • Cursor installed and configured on your machine
  • Node.js 16+ with npm — verify with node --version
  • Active project directory where you want to add gws-gmail-read
2

Run the install command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/googleworkspace/cli --skill gws-gmail-read

Fetches gws-gmail-read from googleworkspace/cli and configures it for Cursor.

3

Select Cursor when prompted

The CLI shows a list of agents. Use arrow keys and space to select Cursor:

◆ Which agents do you want to install to?
│ ── Universal (.agents/skills) ────────────────
│ · Cline · Codex · Goose · Windsurf
│ ●Cursor(selected)
│ · Cursor · Aider · Continue
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/gws-gmail-read

Restart Cursor to activate gws-gmail-read. Access via /gws-gmail-read in your agent's command palette.

Security Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.

Documentation

gmail +read

PREREQUISITE: Read ../gws-shared/SKILL.md for auth, global flags, and security rules. If missing, run gws generate-skills to create it.

Read a message and extract its body or headers

Usage

gws gmail +read --id <ID>

Flags

Flag Required Default Description
--id The Gmail message ID to read
--headers Include headers (From, To, Subject, Date) in the output
--format text Output format (text, json)
--html Return HTML body instead of plain text
--dry-run Show the request that would be sent without executing it

Examples

gws gmail +read --id 18f1a2b3c4d
gws gmail +read --id 18f1a2b3c4d --headers
gws gmail +read --id 18f1a2b3c4d --format json | jq '.body'

Tips

  • Converts HTML-only messages to plain text automatically.
  • Handles multipart/alternative and base64 decoding.

See Also

List & Monetize Your Skill

Submit your Claude Code skill and start earning

Get started →

Use Cases

Task Automation & Efficiency

Automate repetitive workflows and reduce manual effort

Example

Generate reports, summarize documents, draft communications

Save 3-5 hours per week on routine tasks

Knowledge Enhancement

Learn new skills, understand complex topics, get expert guidance

Example

Explain concepts, provide examples, suggest learning resources

Accelerate learning and skill development by 2x

Quality Improvement

Enhance output quality through reviews, suggestions, and refinements

Example

Review drafts, suggest improvements, catch errors

Improve work quality by 30-40% with less effort

Implementation Guide

Prerequisites

  • Claude Desktop or compatible AI client with skill support
  • Clear understanding of task or problem to solve
  • Willingness to iterate and refine outputs

Time Estimate

15-45 minutes depending on use case complexity

Steps

  1. 1Install skill using provided installation command
  2. 2Test with simple use case relevant to your work
  3. 3Evaluate output quality and relevance
  4. 4Iterate on prompts to improve results
  5. 5Integrate into regular workflow if valuable

Common Pitfalls

  • Expecting perfect results without iteration
  • Not providing enough context in prompts
  • Using skill for tasks outside its intended scope
  • Accepting outputs without review and validation

Best Practices

✓ Do

  • +Start with clear, specific prompts
  • +Provide relevant context and constraints
  • +Review and refine all outputs before using
  • +Iterate to improve output quality
  • +Document successful prompt patterns

✗ Don't

  • Don't use without understanding skill limitations
  • Don't skip validation of outputs
  • Don't share sensitive information in prompts
  • Don't expect skill to replace human judgment

💡 Pro Tips

  • Be specific about desired format and style
  • Ask for multiple options to choose from
  • Request explanations to understand reasoning
  • Combine AI efficiency with human expertise

When to Use This

✓ Use when

Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.

✗ Avoid when

Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.

Learning Path

  1. 1Familiarize yourself with skill capabilities and limitations
  2. 2Start with low-risk, non-critical tasks
  3. 3Progress to more complex and valuable use cases
  4. 4Build expertise through regular use and experimentation

Related Skills

Reviews

4.661 reviews
  • S
    Sakura TaylorDec 28, 2024

    I recommend gws-gmail-read for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • G
    Ganesh MohaneDec 20, 2024

    Useful defaults in gws-gmail-read — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • M
    Min DixitDec 20, 2024

    gws-gmail-read has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • B
    Benjamin KimDec 12, 2024

    Keeps context tight: gws-gmail-read is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • H
    Hiroshi PerezNov 19, 2024

    Solid pick for teams standardizing on skills: gws-gmail-read is focused, and the summary matches what you get after install.

  • R
    Rahul SantraNov 11, 2024

    gws-gmail-read has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • A
    Ava HuangNov 11, 2024

    Useful defaults in gws-gmail-read — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • M
    Michael MartinNov 3, 2024

    Registry listing for gws-gmail-read matched our evaluation — installs cleanly and behaves as described in the markdown.

  • B
    Benjamin RamirezOct 22, 2024

    gws-gmail-read reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • S
    Soo AbbasOct 14, 2024

    Solid pick for teams standardizing on skills: gws-gmail-read is focused, and the summary matches what you get after install.

showing 1-10 of 61

1 / 7

Discussion

Comments — not star reviews
  • No comments yet — start the thread.