Gmail Automation via Rube MCP
Automate Gmail operations through Composio's Gmail toolkit via Rube MCP.
Prerequisites
- Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
- Active Gmail connection via
RUBE_MANAGE_CONNECTIONS with toolkit gmail
- Always call
RUBE_SEARCH_TOOLS first to get current tool schemas
Setup
Get Rube MCP: Add https://rube.app/mcp as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
- Verify Rube MCP is available by confirming
RUBE_SEARCH_TOOLS responds
- Call
RUBE_MANAGE_CONNECTIONS with toolkit gmail
- If connection is not ACTIVE, follow the returned auth link to complete Google OAuth
- Confirm connection status shows ACTIVE before running any workflows
Core Workflows
1. Send an Email
When to use: User wants to compose and send a new email
Tool sequence:
GMAIL_SEARCH_PEOPLE - Resolve contact name to email address [Optional]
GMAIL_SEND_EMAIL - Send the email [Required]
Key parameters:
recipient_email: Email address or 'me' for self
subject: Email subject line
body: Email content (plain text or HTML)
is_html: Must be true if body contains HTML markup
cc/bcc: Arrays of email addresses
attachment: Object with {s3key, mimetype, name} from prior download
Pitfalls:
- At least one of
recipient_email, cc, or bcc required
- At least one of
subject or body required
- Attachment
mimetype MUST contain '/' (e.g., 'application/pdf', not 'pdf')
- Total message size limit ~25MB after base64 encoding
- Use
from_email only for verified aliases in Gmail 'Send mail as' settings
2. Reply to a Thread
When to use: User wants to reply to an existing email conversation
Tool sequence:
GMAIL_FETCH_EMAILS - Find the email/thread to reply to [Prerequisite]
GMAIL_REPLY_TO_THREAD - Send reply within the thread [Required]
Key parameters:
thread_id: Hex string from FETCH_EMAILS (e.g., '169eefc8138e68ca')
message_body: Reply content
recipient_email: Reply recipient
is_html: Set true for HTML content
Pitfalls:
thread_id must be hex string; prefixes like 'msg-f:' are auto-stripped
- Legacy Gmail web UI IDs (e.g., 'FMfcgz...') are NOT supported
- Subject is inherited from original thread; setting it creates a new thread instead
- Do NOT include subject parameter to stay within thread
3. Search and Filter Emails
When to use: User wants to find specific emails by sender, subject, date, label, etc.
Tool sequence:
GMAIL_FETCH_EMAILS - Search with Gmail query syntax [Required]
GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID - Get full message details for selected results [Optional]
Key parameters:
query: Gmail search syntax (from:, to:, subject:, is:unread, has:attachment, after:YYYY/MM/DD, before:YYYY/MM/DD)
max_results: 1-500 messages per page
label_ids: System IDs like 'INBOX', 'UNREAD'
include_payload: Set true to get full message content
ids_only: Set true for just message IDs
page_token: For pagination (from nextPageToken)
Pitfalls:
- Returns max ~500 per page; follow
nextPageToken via page_token until absent
resultSizeEstimate is approximate, not exact count
- Use 'is:' for states (is:unread, is:snoozed, is:starred)
- Use 'label:' ONLY for user-created labels
- Common mistake: 'label:snoozed' is WRONG — use 'is:snoozed'
include_payload=true on broad searches creates huge responses; default to metadata
- Custom labels require label ID (e.g., 'Label_123'), NOT label name
4. Manage Labels
When to use: User wants to create, modify, or organize labels
Tool sequence:
GMAIL_LIST_LABELS - List all labels to find IDs and detect conflicts [Required]
GMAIL_CREATE_LABEL - Create a new label [Optional]
GMAIL_PATCH_LABEL - Rename or change label colors/visibility [Optional]
GMAIL_DELETE_LABEL - Delete a user-created label (irreversible) [Optional]
Key parameters:
label_name: Max 225 chars, no commas, '/' for nesting (e.g., 'Work/Projects')
background_color/text_color: Hex values from Gmail's predefined palette
id: Label ID for PATCH/DELETE operations
Pitfalls:
- 400/409 error if name is blank, duplicate, or reserved (INBOX, SPAM, CATEGORY_*)
- Color specs must use Gmail's predefined palette of 102 hex values
- DELETE is permanent and removes label from all messages
- Cannot delete system labels (INBOX, SENT, DRAFT, etc.)
5. Apply/Remove Labels on Messages
When to use: User wants to label, archive, or mark emails as read/unread
Tool sequence:
GMAIL_LIST_LABELS - Get label IDs for custom labels [Prerequisite]
GMAIL_FETCH_EMAILS - Find target messages [Prerequisite]
GMAIL_BATCH_MODIFY_MESSAGES - Bulk add/remove labels (up to 1000 messages) [Required]
GMAIL_ADD_LABEL_TO_EMAIL - Single-message label changes [Fallback]
Key parameters:
messageIds: Array of message IDs (max 1000)
addLabelIds: Array of label IDs to add
removeLabelIds: Array of label IDs to remove
message_id: 15-16 char hex string for single operations
Pitfalls:
- Max 1000 messageIds per BATCH call; chunk larger sets
- Use 'CATEGORY_UPDATES' not 'UPDATES'; full prefix required for category labels
- SENT, DRAFT, CHAT are immutable — cannot be added/removed
- To mark as read: REMOVE 'UNREAD'. To archive: REMOVE 'INBOX'
message_id must be 15-16 char hex, NOT UUIDs or web UI IDs
6. Handle Drafts and Attachments
When to use: User wants to create, edit, or send email drafts, possibly with attachments
Tool sequence:
GMAIL_CREATE_EMAIL_DRAFT - Create a new draft [Required]
GMAIL_UPDATE_DRAFT - Edit draft content [Optional]
GMAIL_LIST_DRAFTS - List existing drafts [Optional]
GMAIL_SEND_DRAFT - Send a draft (requires explicit user approval) [Optional]
GMAIL_GET_ATTACHMENT - Download attachment from existing message [Optional]
Key parameters:
recipient_email: Draft recipient
subject: Draft subject (omit for reply drafts to stay in thread)
body: Draft content
is_html: Set true for HTML content
attachment: Object with {s3key, mimetype, name}
thread_id: For reply drafts (leave subject empty to stay in thread)
Pitfalls:
- Response includes
data.id (draft_id) AND data.message.id; use data.id for draft operations
- Setting subject on a thread reply draft creates a NEW thread instead
- Attachment capped at ~25MB; base64 overhead can push near-limit files over
- UPDATE_DRAFT replaces entire content, not patches; include all fields you want to keep
- HTTP 429 on bulk draft creation; use exponential backoff
Common Patterns
ID Resolution
Label name → Label ID:
1. Call GMAIL_LIST_LABELS
2. Find label by name in response
3. Extract id field (e.g., 'Label_123')
Contact name → Email:
1. Call GMAIL_SEARCH_PEOPLE with query=contact_name
2. Extract emailAddresses from response
Thread ID from search:
1. Call GMAIL_FETCH_EMAILS or GMAIL_LIST_THREADS
2. Extract threadId (15-16 char hex string)
Pagination
- Set
max_results up to 500 per page
- Check response for
nextPageToken
- Pass token as
page_token in next request
- Continue until
nextPageToken is absent or empty string
resultSizeEstimate is approximate, not exact
Gmail Query Syntax
Operators:
from:sender@example.com - Emails from sender
to:recipient@example.com - Emails to recipient
subject:"exact phrase" - Subject contains exact phrase
is:unread - Unread messages
is:starred - Starred messages
is:snoozed - Snoozed messages
has:attachment - Has attachments
after:2024/01/01 - After date (YYYY/MM/DD)
before:2024/12/31 - Before date
label:custom_label - User-created label (use label ID)
in:sent - In sent folder
category:primary - Primary category
Combinators:
AND - Both conditions (default)
OR - Either condition
NOT - Exclude condition
() - Group conditions
Examples:
from:boss@company.com is:unread - Unread emails from boss
subject:invoice has:attachment after:2024/01/01 - Invoices with attachments this year
(from:alice OR from:bob) is:starred - Starred emails from Alice or Bob
Known Pitfalls
ID Formats:
- Custom label operations require label IDs (e.g., 'Label_123'), not display names
- Always call LIST_LABELS first to resolve names to IDs
- Message IDs are 15-16 char hex strings
- Do NOT use UUIDs, web UI IDs, or 'thread-f:' prefixes
Query Syntax:
- Use 'is:' for states (unread, snoozed, starred)
- Use 'label:' ONLY for user-created labels
- System labels use 'is:' or 'in:' (e.g., 'is:sent', 'in:inbox')
Rate Limits:
- BATCH_MODIFY_MESSAGES max 1000 messages per call
- Heavy use triggers 403/429 rate limits
- Implement exponential backoff for bulk operations
Response Parsing:
- Response data may be nested under
data_preview or data.messages
- Parse defensively with fallbacks
- Timestamp
messageTimestamp uses RFC3339 with 'Z' suffix
- Normalize to '+00:00' for parsing if needed
Attachments:
- Attachment
s3key from prior download may expire
- Use promptly after retrieval
- Mimetype must include '/' separator
Quick Reference
| Task |
Tool Slug |
Key Params |
| Send email |
GMAIL_SEND_EMAIL |
recipient_email, subject, body, is_html |
| Reply to thread |
GMAIL_REPLY_TO_THREAD |
thread_id, message_body, recipient_email |
| Search emails |
GMAIL_FETCH_EMAILS |
query, max_results, label_ids, page_token |
| Get message details |
GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID |
message_id |
| List labels |
GMAIL_LIST_LABELS |
(none) |
| Create label |
GMAIL_CREATE_LABEL |
label_name, background_color, text_color |
| Modify labels bulk |
GMAIL_BATCH_MODIFY_MESSAGES |
messageIds, addLabelIds, removeLabelIds |
| Create draft |
GMAIL_CREATE_EMAIL_DRAFT |
recipient_email, subject, body, thread_id |
| Send draft |
GMAIL_SEND_DRAFT |
draft_id |
| Get attachment |
GMAIL_GET_ATTACHMENT |
message_id, attachment_id |
| Search contacts |
GMAIL_SEARCH_PEOPLE |
query |
| Get profile |
GMAIL_GET_PROFILE |
(none) |
1---2name: openakita-skills-gmail-automation3description: Automate Gmail tasks via Rube MCP (Composio): send/reply, search, labels, drafts, attachments. Always search tools first for current schemas.4license: MIT5---6
7# Gmail Automation via Rube MCP
8
9Automate Gmail operations through Composio's Gmail toolkit via Rube MCP.
10
11## Prerequisites
12
13- Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
14- Active Gmail connection via `RUBE_MANAGE_CONNECTIONS` with toolkit `gmail`
15- Always call `RUBE_SEARCH_TOOLS` first to get current tool schemas
16
17## Setup
18
19**Get Rube MCP**: Add `https://rube.app/mcp` as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
20
21
221. Verify Rube MCP is available by confirming `RUBE_SEARCH_TOOLS` responds
232. Call `RUBE_MANAGE_CONNECTIONS` with toolkit `gmail`
243. If connection is not ACTIVE, follow the returned auth link to complete Google OAuth
254. Confirm connection status shows ACTIVE before running any workflows
26
27## Core Workflows
28
29### 1. Send an Email
30
31**When to use**: User wants to compose and send a new email
32
33**Tool sequence**:
341. `GMAIL_SEARCH_PEOPLE` - Resolve contact name to email address [Optional]
352. `GMAIL_SEND_EMAIL` - Send the email [Required]
36
37**Key parameters**:
38- `recipient_email`: Email address or 'me' for self
39- `subject`: Email subject line
40- `body`: Email content (plain text or HTML)
41- `is_html`: Must be `true` if body contains HTML markup
42- `cc`/`bcc`: Arrays of email addresses
43- `attachment`: Object with `{s3key, mimetype, name}` from prior download
44
45**Pitfalls**:
46- At least one of `recipient_email`, `cc`, or `bcc` required
47- At least one of `subject` or `body` required
48- Attachment `mimetype` MUST contain '/' (e.g., 'application/pdf', not 'pdf')
49- Total message size limit ~25MB after base64 encoding
50- Use `from_email` only for verified aliases in Gmail 'Send mail as' settings
51
52### 2. Reply to a Thread
53
54**When to use**: User wants to reply to an existing email conversation
55
56**Tool sequence**:
571. `GMAIL_FETCH_EMAILS` - Find the email/thread to reply to [Prerequisite]
582. `GMAIL_REPLY_TO_THREAD` - Send reply within the thread [Required]
59
60**Key parameters**:
61- `thread_id`: Hex string from FETCH_EMAILS (e.g., '169eefc8138e68ca')
62- `message_body`: Reply content
63- `recipient_email`: Reply recipient
64- `is_html`: Set `true` for HTML content
65
66**Pitfalls**:
67- `thread_id` must be hex string; prefixes like 'msg-f:' are auto-stripped
68- Legacy Gmail web UI IDs (e.g., 'FMfcgz...') are NOT supported
69- Subject is inherited from original thread; setting it creates a new thread instead
70- Do NOT include subject parameter to stay within thread
71
72### 3. Search and Filter Emails
73
74**When to use**: User wants to find specific emails by sender, subject, date, label, etc.
75
76**Tool sequence**:
771. `GMAIL_FETCH_EMAILS` - Search with Gmail query syntax [Required]
782. `GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID` - Get full message details for selected results [Optional]
79
80**Key parameters**:
81- `query`: Gmail search syntax (from:, to:, subject:, is:unread, has:attachment, after:YYYY/MM/DD, before:YYYY/MM/DD)
82- `max_results`: 1-500 messages per page
83- `label_ids`: System IDs like 'INBOX', 'UNREAD'
84- `include_payload`: Set `true` to get full message content
85- `ids_only`: Set `true` for just message IDs
86- `page_token`: For pagination (from `nextPageToken`)
87
88**Pitfalls**:
89- Returns max ~500 per page; follow `nextPageToken` via `page_token` until absent
90- `resultSizeEstimate` is approximate, not exact count
91- Use 'is:' for states (is:unread, is:snoozed, is:starred)
92- Use 'label:' ONLY for user-created labels
93- Common mistake: 'label:snoozed' is WRONG — use 'is:snoozed'
94- `include_payload=true` on broad searches creates huge responses; default to metadata
95- Custom labels require label ID (e.g., 'Label_123'), NOT label name
96
97### 4. Manage Labels
98
99**When to use**: User wants to create, modify, or organize labels
100
101**Tool sequence**:
1021. `GMAIL_LIST_LABELS` - List all labels to find IDs and detect conflicts [Required]
1032. `GMAIL_CREATE_LABEL` - Create a new label [Optional]
1043. `GMAIL_PATCH_LABEL` - Rename or change label colors/visibility [Optional]
1054. `GMAIL_DELETE_LABEL` - Delete a user-created label (irreversible) [Optional]
106
107**Key parameters**:
108- `label_name`: Max 225 chars, no commas, '/' for nesting (e.g., 'Work/Projects')
109- `background_color`/`text_color`: Hex values from Gmail's predefined palette
110- `id`: Label ID for PATCH/DELETE operations
111
112**Pitfalls**:
113- 400/409 error if name is blank, duplicate, or reserved (INBOX, SPAM, CATEGORY_*)
114- Color specs must use Gmail's predefined palette of 102 hex values
115- DELETE is permanent and removes label from all messages
116- Cannot delete system labels (INBOX, SENT, DRAFT, etc.)
117
118### 5. Apply/Remove Labels on Messages
119
120**When to use**: User wants to label, archive, or mark emails as read/unread
121
122**Tool sequence**:
1231. `GMAIL_LIST_LABELS` - Get label IDs for custom labels [Prerequisite]
1242. `GMAIL_FETCH_EMAILS` - Find target messages [Prerequisite]
1253. `GMAIL_BATCH_MODIFY_MESSAGES` - Bulk add/remove labels (up to 1000 messages) [Required]
1264. `GMAIL_ADD_LABEL_TO_EMAIL` - Single-message label changes [Fallback]
127
128**Key parameters**:
129- `messageIds`: Array of message IDs (max 1000)
130- `addLabelIds`: Array of label IDs to add
131- `removeLabelIds`: Array of label IDs to remove
132- `message_id`: 15-16 char hex string for single operations
133
134**Pitfalls**:
135- Max 1000 messageIds per BATCH call; chunk larger sets
136- Use 'CATEGORY_UPDATES' not 'UPDATES'; full prefix required for category labels
137- SENT, DRAFT, CHAT are immutable — cannot be added/removed
138- To mark as read: REMOVE 'UNREAD'. To archive: REMOVE 'INBOX'
139- `message_id` must be 15-16 char hex, NOT UUIDs or web UI IDs
140
141### 6. Handle Drafts and Attachments
142
143**When to use**: User wants to create, edit, or send email drafts, possibly with attachments
144
145**Tool sequence**:
1461. `GMAIL_CREATE_EMAIL_DRAFT` - Create a new draft [Required]
1472. `GMAIL_UPDATE_DRAFT` - Edit draft content [Optional]
1483. `GMAIL_LIST_DRAFTS` - List existing drafts [Optional]
1494. `GMAIL_SEND_DRAFT` - Send a draft (requires explicit user approval) [Optional]
1505. `GMAIL_GET_ATTACHMENT` - Download attachment from existing message [Optional]
151
152**Key parameters**:
153- `recipient_email`: Draft recipient
154- `subject`: Draft subject (omit for reply drafts to stay in thread)
155- `body`: Draft content
156- `is_html`: Set `true` for HTML content
157- `attachment`: Object with `{s3key, mimetype, name}`
158- `thread_id`: For reply drafts (leave subject empty to stay in thread)
159
160**Pitfalls**:
161- Response includes `data.id` (draft_id) AND `data.message.id`; use `data.id` for draft operations
162- Setting subject on a thread reply draft creates a NEW thread instead
163- Attachment capped at ~25MB; base64 overhead can push near-limit files over
164- UPDATE_DRAFT replaces entire content, not patches; include all fields you want to keep
165- HTTP 429 on bulk draft creation; use exponential backoff
166
167## Common Patterns
168
169### ID Resolution
170
171**Label name → Label ID**:
172```
1731. Call GMAIL_LIST_LABELS
1742. Find label by name in response
1753. Extract id field (e.g., 'Label_123')
176```
177
178**Contact name → Email**:
179```
1801. Call GMAIL_SEARCH_PEOPLE with query=contact_name
1812. Extract emailAddresses from response
182```
183
184**Thread ID from search**:
185```
1861. Call GMAIL_FETCH_EMAILS or GMAIL_LIST_THREADS
1872. Extract threadId (15-16 char hex string)
188```
189
190### Pagination
191
192- Set `max_results` up to 500 per page
193- Check response for `nextPageToken`
194- Pass token as `page_token` in next request
195- Continue until `nextPageToken` is absent or empty string
196- `resultSizeEstimate` is approximate, not exact
197
198### Gmail Query Syntax
199
200**Operators**:
201- `from:sender@example.com` - Emails from sender
202- `to:recipient@example.com` - Emails to recipient
203- `subject:"exact phrase"` - Subject contains exact phrase
204- `is:unread` - Unread messages
205- `is:starred` - Starred messages
206- `is:snoozed` - Snoozed messages
207- `has:attachment` - Has attachments
208- `after:2024/01/01` - After date (YYYY/MM/DD)
209- `before:2024/12/31` - Before date
210- `label:custom_label` - User-created label (use label ID)
211- `in:sent` - In sent folder
212- `category:primary` - Primary category
213
214**Combinators**:
215- `AND` - Both conditions (default)
216- `OR` - Either condition
217- `NOT` - Exclude condition
218- `()` - Group conditions
219
220**Examples**:
221- `from:boss@company.com is:unread` - Unread emails from boss
222- `subject:invoice has:attachment after:2024/01/01` - Invoices with attachments this year
223- `(from:alice OR from:bob) is:starred` - Starred emails from Alice or Bob
224
225## Known Pitfalls
226
227**ID Formats**:
228- Custom label operations require label IDs (e.g., 'Label_123'), not display names
229- Always call LIST_LABELS first to resolve names to IDs
230- Message IDs are 15-16 char hex strings
231- Do NOT use UUIDs, web UI IDs, or 'thread-f:' prefixes
232
233**Query Syntax**:
234- Use 'is:' for states (unread, snoozed, starred)
235- Use 'label:' ONLY for user-created labels
236- System labels use 'is:' or 'in:' (e.g., 'is:sent', 'in:inbox')
237
238**Rate Limits**:
239- BATCH_MODIFY_MESSAGES max 1000 messages per call
240- Heavy use triggers 403/429 rate limits
241- Implement exponential backoff for bulk operations
242
243**Response Parsing**:
244- Response data may be nested under `data_preview` or `data.messages`
245- Parse defensively with fallbacks
246- Timestamp `messageTimestamp` uses RFC3339 with 'Z' suffix
247- Normalize to '+00:00' for parsing if needed
248
249**Attachments**:
250- Attachment `s3key` from prior download may expire
251- Use promptly after retrieval
252- Mimetype must include '/' separator
253
254## Quick Reference
255
256| Task | Tool Slug | Key Params |
257|------|-----------|------------|
258| Send email | GMAIL_SEND_EMAIL | recipient_email, subject, body, is_html |
259| Reply to thread | GMAIL_REPLY_TO_THREAD | thread_id, message_body, recipient_email |
260| Search emails | GMAIL_FETCH_EMAILS | query, max_results, label_ids, page_token |
261| Get message details | GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID | message_id |
262| List labels | GMAIL_LIST_LABELS | (none) |
263| Create label | GMAIL_CREATE_LABEL | label_name, background_color, text_color |
264| Modify labels bulk | GMAIL_BATCH_MODIFY_MESSAGES | messageIds, addLabelIds, removeLabelIds |
265| Create draft | GMAIL_CREATE_EMAIL_DRAFT | recipient_email, subject, body, thread_id |
266| Send draft | GMAIL_SEND_DRAFT | draft_id |
267| Get attachment | GMAIL_GET_ATTACHMENT | message_id, attachment_id |
268| Search contacts | GMAIL_SEARCH_PEOPLE | query |
269| Get profile | GMAIL_GET_PROFILE | (none) |