Gmail CLI for AI Agents

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Gmail logo
CLI logo
divider

Introduction

CLIs are eating MCPs. The industry is converging on the very same idea. MCPs for all their merit can be token hungry, slow, and unreliable for complex tool chaining. However, coding agents have become incredibly good at working with CLIs, and in fact they are far more comfortable working with CLI tools than MCP.

With Composio's Universal CLI, your coding agents can talk to over 1000+ SaaS applications. With Gmail, agents can read emails, search your inbox, draft messages, manage labels, and organize threads, and more — all without worrying about authentication.

This guide walks you through Composio Universal CLI and explains how you can connect it with coding agents like Claude Code, Codex, OpenCode, etc, for end-to-end Gmail automation.

Also integrate Gmail with

What is Universal CLI and why use it?

The idea behind building the universal CLI is to give agents a single command interface to interact with all your external applications. Here's what you'll get with it:

  • Agent-friendly: Coding agents like Claude Code, Codex, and OpenCode can use CLI tools natively — no MCP setup required.
  • Authentication handled: Connect once via OAuth or API Key, and all CLI commands work with your credentials automatically.
  • Tool discovery: Search, inspect, and execute 20,000+ tools across 1000+ apps from one interface.
  • Trigger support: Use triggers to listen for events across your apps, powered by real-time webhooks or polling under the hood.
  • Type generation: Generate typed schemas for autocomplete and type safety in your projects.

Prerequisites

Install the Composio CLI, authenticate, and initialize your project:

bash
# Install the Composio CLI
curl -fsSL https://composio.dev/install | bash

# Authenticate with Composio
composio login

During login you'll be redirected to sign in page, finish the complete flow and you're all set.

Composio CLI authentication flow

Connecting Gmail to Coding Agents via Universal CLI

Once it is installed, it's essentially done. Claude Code, Codex, OpenCode, OpenClaw, or any other agent will be able to access the CLI. A few steps to give agents access to your apps.

  1. Launch your Coding Agent — Claude Code, Codex, OpenCode, anything you prefer.
  2. Prompt it to "Authenticate with Gmail"
  3. Complete the authentication and authorization flow and your Gmail integration is all set.
  4. Start asking anything you want.

Supported Tools & Triggers

Tools
Triggers
Modify email labelsAdds and/or removes specified Gmail labels for a message; ensure `message_id` and all `label_ids` are valid (use 'listLabels' for custom label IDs).
Batch delete Gmail messagesTool to permanently delete multiple Gmail messages in bulk, bypassing Trash with no recovery possible.
Batch modify Gmail messagesModify labels on multiple Gmail messages in one efficient API call.
Create email draftCreates a Gmail email draft.
Create Gmail filterTool to create a new Gmail filter with specified criteria and actions.
Create labelCreates a new label with a unique name in the specified user's Gmail account.
Create Prompt PostSend a one-shot prompt to the Sanity Content Agent.
Delete DraftPermanently deletes a specific Gmail draft using its ID with no recovery possible; verify the correct `draft_id` and obtain explicit user confirmation before calling.
Delete Gmail filterTool to permanently delete a Gmail filter by its ID.
Delete label from account (permanent)Permanently DELETES a user-created Gmail label from the account (not from a message).
Delete messagePermanently deletes a specific email message by its ID from a Gmail mailbox; for `user_id`, use 'me' for the authenticated user or an email address to which the authenticated user has delegated access.
Delete threadTool to immediately and permanently delete a specified thread and all its messages.
Fetch emailsFetches a list of email messages from a Gmail account, supporting filtering, pagination, and optional full content retrieval.
Fetch message by message IDFetches a specific email message by its ID, provided the `message_id` exists and is accessible to the authenticated `user_id`.
Fetch Message by Thread IDRetrieves messages from a Gmail thread using its `thread_id`, where the thread must be accessible by the specified `user_id`.
Forward email messageForward an existing Gmail message to specified recipients, preserving original body and attachments.
Get Gmail attachmentRetrieves a specific attachment by ID from a message in a user's Gmail mailbox, requiring valid message and attachment IDs.
Get Auto-Forwarding SettingsTool to get the auto-forwarding setting for the specified account.
Get contactsFetches contacts (connections) for the authenticated Google account, allowing selection of specific data fields and pagination.
Get DraftRetrieves a single Gmail draft by its ID.
Get Gmail filterTool to retrieve a specific Gmail filter by its ID.
Get label detailsGets details for a specified Gmail label.
Get Language SettingsTool to retrieve the language settings for a Gmail user.
Get PeopleRetrieves either a specific person's details (using `resource_name`) or lists 'Other Contacts' (if `other_contacts` is true), with `person_fields` specifying the data to return.
Get ProfileRetrieves Gmail profile information (email address, aggregate messagesTotal/threadsTotal, historyId) for a user.
Get Vacation SettingsTool to retrieve vacation responder settings for a Gmail user.
Import messageTool to import a message into the user's mailbox with standard email delivery scanning and classification.
Insert message into mailboxTool to insert a message into the user's mailbox similar to IMAP APPEND.
List CSE identitiesTool to list client-side encrypted identities for an authenticated user.
List CSE key pairsTool to list client-side encryption key pairs for an authenticated user.
List DraftsRetrieves a paginated list of email drafts from a user's Gmail account.
List Gmail filtersTool to list all Gmail filters (rules) in the mailbox.
List forwarding addressesTool to list all forwarding addresses for the specified Gmail account.
List Gmail historyTool to list Gmail mailbox change history since a known startHistoryId.
List Gmail labelsRetrieves all system and user-created labels for a Gmail account in a single unpaginated response.
List send-as aliasesLists the send-as aliases for a Gmail account, including the primary address and custom 'from' aliases.
List S/MIME configsLists S/MIME configs for the specified send-as alias.
List threadsRetrieves a list of email threads from a Gmail account, identified by `user_id` (email address or 'me'), supporting filtering and pagination.
Modify thread labelsAdds or removes specified existing label IDs from a Gmail thread, affecting all its messages; ensure the thread ID is valid.
Trash threadMoves the specified thread to the trash.
Move to TrashMoves an existing, non-deleted email message to the trash for the specified user.
Patch LabelPatches the specified user-created label.
Patch send-as aliasTool to patch the specified send-as alias for a Gmail user.
Reply to email threadSends a reply within a specific Gmail thread using the original thread's subject; do not provide a custom subject as it will start a new conversation instead of replying in-thread.
Search PeopleSearches contacts by matching the query against names, nicknames, emails, phone numbers, and organizations, optionally including 'Other Contacts'.
Send DraftSends an existing draft email AS-IS to recipients already defined within the draft.
Send EmailSends an email via Gmail API using the authenticated user's Google profile display name.
Get IMAP SettingsRetrieves the IMAP settings for a Gmail user account, including whether IMAP is enabled, auto-expunge behavior, expunge behavior, and maximum folder size.
Get POP settingsTool to retrieve POP settings for a Gmail account.
Get send-as aliasTool to retrieve a specific send-as alias configuration for a Gmail user.
Stop watch notificationsTool to stop receiving push notifications for a Gmail mailbox.
Untrash MessageTool to remove a message from trash in Gmail.
Untrash threadTool to remove a thread from trash in Gmail.
Update draftUpdates (replaces) an existing Gmail draft's content in-place by draft ID.
Update IMAP settingsTool to update IMAP settings for a Gmail account.
Update LabelTool to update the properties of an existing Gmail label.
Update Language SettingsTool to update the language settings for a Gmail user.
Update POP settingsTool to update POP settings for a Gmail account.
Update send-as aliasTool to update a send-as alias for a Gmail user.
Update User Attributes ValuesUpdate user attribute values for a resource.
Update Vacation SettingsTool to update vacation responder settings for a Gmail user.

Universal CLI Commands for Gmail

You can also manually execute CLI commands to interact with your Gmail.

Connect your Gmail account

Link your Gmail account and verify the connection:

bash
# Connect your Gmail account (opens OAuth flow)
composio connected-accounts link gmail

# Verify the connection
composio connected-accounts list --toolkits gmail

Discover Gmail tools

Search and inspect available Gmail tools:

bash
# List all available Gmail tools
composio tools list --toolkit gmail

# Search for Gmail tools by action
composio tools search "gmail"

# Inspect a tool's input schema
composio tools info GMAIL_ADD_LABEL_TO_EMAIL

Common Gmail Actions

Modify email labels — Adds and/or removes specified gmail labels for a message; ensure `message id` and all `label ids` are valid (use 'listlabels' for custom label ids)

bash
composio tools execute GMAIL_ADD_LABEL_TO_EMAIL \
  --message_id "17f1b2b9c1b2a3d4"

Create email draft — Creates a gmail email draft, supporting to/cc/bcc, subject, plain/html body (ensure `is html=true` for html), attachments, and threading

bash
composio tools execute GMAIL_CREATE_EMAIL_DRAFT \
  --body "Hello Team,  Please find the attached report for your review.  Best regards, Your Name" \
  --subject "Project Update Q3" \
  --recipient_email "john.doe@example.com"

Create label — Creates a new label with a unique name in the specified user's gmail account

bash
composio tools execute GMAIL_CREATE_LABEL \
  --label_name "Work"

Delete Draft — Permanently deletes a specific gmail draft using its id; ensure the draft exists and the user has necessary permissions for the given `user id`

bash
composio tools execute GMAIL_DELETE_DRAFT \
  --draft_id "r-8388446164079304564"

Set up Gmail Triggers

Listen for events in real time using triggers:

Email Sent — Triggers when a Gmail message is sent by the authenticated user

bash
# Find your connected account ID
composio connected-accounts list --toolkits gmail

# Create a trigger
composio triggers create GMAIL_EMAIL_SENT_TRIGGER \
  --connected-account-id <your-connected-account-id> \
  --trigger-config '{
  "query": "to:someone@example.com",
  "userId": "me",
  "interval": 2
}'

# Listen for trigger events in real time
composio triggers listen --toolkits gmail --table

New Gmail Message Received Trigger — Triggers when a new message is received in Gmail

bash
# Find your connected account ID
composio connected-accounts list --toolkits gmail

# Create a trigger
composio triggers create GMAIL_NEW_GMAIL_MESSAGE \
  --connected-account-id <your-connected-account-id> \
  --trigger-config '{
  "query": "label:inbox OR label:sent",
  "interval": 2,
  "labelIds": "INBOX"
}'

# Listen for trigger events in real time
composio triggers listen --toolkits gmail --table

Generate Type Definitions

Generate typed schemas for Gmail tools to get autocomplete and type safety in your project:

bash
# Auto-detect language
composio generate --toolkits gmail

# TypeScript
composio ts generate --toolkits gmail

# Python
composio py generate --toolkits gmail

Tips & Tricks

  • Always inspect a tool's input schema before executing: composio tools info <TOOL_NAME>
  • Pipe output with jq for better readability: composio tools execute TOOL_NAME -d '{}' | jq
  • Set COMPOSIO_API_KEY as an environment variable for CI/CD pipelines
  • Use composio dev logs tools to inspect execution logs and debug issues

Next Steps

  • Try asking your coding agent to perform various Gmail operations
  • Explore cross-app workflows by connecting more toolkits
  • Set up triggers for real-time automation
  • Use composio generate for typed schemas in your projects

How to build Gmail MCP Agent with another framework

ChatGPT logo

ChatGPT

Use Gmail MCP with ChatGPT

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Gmail MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Gmail MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Gmail MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Gmail MCP with Claude Cowork

Codex logo

Codex

Use Gmail MCP with Codex

Cursor logo

Cursor

Use Gmail MCP with Cursor

OpenClaw logo

OpenClaw

Use Gmail MCP with OpenClaw

Hermes logo

Hermes

Use Gmail MCP with Hermes

Google ADK logo

Google ADK

Use Gmail MCP with Google ADK

LangChain logo

LangChain

Use Gmail MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Gmail MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Gmail MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Gmail MCP with LlamaIndex

CrewAI logo

CrewAI

Use Gmail MCP with CrewAI

OpenCode logo

OpenCode

Use Gmail MCP with OpenCode

VS Code logo

VS Code

Use Gmail MCP with VS Code

FAQ

What is the Composio Universal CLI?

The Composio Universal CLI is a single command-line interface that lets coding agents and developers interact with 1000+ SaaS applications. It handles authentication, tool discovery, action execution, and trigger setup — all from the terminal, without needing to configure MCP servers.

Which coding agents work with the Composio CLI?

Any coding agent that can run shell commands works with the Composio CLI — including Claude Code, Codex, OpenCode, OpenClaw, and others. Once the CLI is installed, agents automatically discover and use the composio commands to interact with Gmail and other connected apps.

How is the CLI different from using an MCP server for Gmail?

MCP servers require configuration and can be token-heavy for complex workflows. The CLI gives agents a direct, lightweight interface — no server setup needed. Agents simply call composio commands like any other shell tool. It's faster to set up, more reliable for multi-step tool chaining, and works natively with how coding agents already operate.

How safe is my Gmail data when using the Composio CLI?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Gmail data and credentials are handled as safely as possible. You can also bring your own OAuth credentials for full control.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for freeGet a demo↗