SIGN UPLOG IN
X (Twitter)LinkedInGitHubDiscordYouTube

How to integrate Gmail MCP with OpenAI Agents SDK

Connect OpenAI Agents SDK to Gmail MCP. Summarize unread emails from this morning, create draft replies to urgent messages, and more using natural language, with authentication handled for you.

Get started for freeGet a demo
Gmail logoGmail
Oauth2

Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable.

61 Tools2 Triggers

Introduction

This guide walks you through connecting Gmail to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Gmail agent that can read emails, search your inbox, draft messages, manage labels, and organize threads through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Gmail account through Composio's Gmail MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Gmail with

Claude CodeCursorChatGPTClaude CoworkAntigravityClaude Agent SDKGrok BotMuseCodexKimi CodeGrok BuildVS CodeOpenCodeOpenClawHermesAtomic AgentPiDeepSeek HarnessCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAIPydantic AIAutoGen

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Gmail
  • Configure an AI agent that can use Gmail as a tool
  • Run a live chat session where you can ask the agent to perform Gmail operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

What is the Gmail MCP server, and what's possible with it?

The Gmail MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Gmail account. It provides structured and secure access to your email, drafts, attachments, labels, and contacts, so your agent can read messages, send emails, manage drafts, organize your inbox, and handle conversations on your behalf.

  • Email search and reading: Instruct your agent to find emails using filters, read complete messages, and retrieve specific attachments.
  • Drafting and sending: Have your agent create, update, review, send, or delete drafts, and send new emails from your Gmail account.
  • Replies and conversation management: Let the agent reply within existing email threads and move conversations to or from the trash.
  • Inbox and label organization: Direct your agent to modify labels across multiple messages and update the properties of existing Gmail labels.
  • Contact and account lookup: Have your agent search contacts by personal or workplace details and identify the connected Gmail account.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Gmail project
  • Some knowledge of Python or Typescript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Gmail.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Gmail
const session = await composio.create(userId as string, {
  toolkits: ['gmail'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only gmail.
  • The router checks the user's Gmail connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Gmail.
  • This approach keeps things lightweight and lets the agent request Gmail tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Gmail. Help users perform Gmail operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Gmail and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Gmail operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

  if (!text) {
    rl.prompt();
    return;
  }

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Gmail.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Gmail and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['gmail'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Gmail. Help users perform Gmail operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

    if (!text) {
      rl.prompt();
      return;
    }

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Gmail MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Gmail.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS & TRIGGERS

Supported Tools and Triggers

Every Gmail action and event your agent gets out of the box.

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).

Batch delete Gmail messages

Permanently deletes multiple Gmail messages by ID, bypassing Trash.

Batch modify Gmail messages

Adds or removes labels on up to 1,000 Gmail messages in one request, supporting operations such as archiving and marking messages read or unread.

Create email draft

Creates a Gmail draft with optional recipients, subject, plain or HTML body, attachments, and threading.

Create Gmail filter

Tool to create a new Gmail filter with specified criteria and actions.

Create label

Creates a Gmail label and returns its label ID.

Delete Draft

Permanently 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 filter

Tool 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 message

Permanently 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 thread

Tool to immediately and permanently delete a specified thread and all its messages.

Fetch emails

Lists Gmail messages with query and label filtering, pagination, and optional message details.

Fetch message by message ID

Fetches a Gmail message by its message ID in the requested format and returns formatted message details.

Fetch Message by Thread ID

Retrieves messages from an accessible Gmail thread by thread ID, returning thread details and a messages array.

Forward email message

Forwards an existing Gmail message to specified recipients, with optional additional text.

Get Gmail attachment

Retrieves a Gmail message attachment by message and attachment IDs and returns a downloadable file using the supplied filename.

Get Auto-Forwarding Settings

Tool to get the auto-forwarding setting for the specified account.

Get contacts

Lists saved Google contacts with selectable fields and pagination, optionally including Other Contacts.

Get Draft

Retrieves a single Gmail draft by its ID.

Get Gmail filter

Tool to retrieve a specific Gmail filter by its ID.

Get label details

Gets details for a specified Gmail label.

Get Language Settings

Tool to retrieve the language settings for a Gmail user.

Get People

Retrieves a person's details by resource name or lists the authenticated user's Other Contacts, using a field mask to select the information returned.

Get Profile

Retrieves Gmail profile information (email address, aggregate messagesTotal/threadsTotal, historyId) for a user.

Get Vacation Settings

Tool to retrieve vacation responder settings for a Gmail user.

Import message

Tool to import a message into the user's mailbox with standard email delivery scanning and classification.

Insert message into mailbox

Tool to insert a message into the user's mailbox similar to IMAP APPEND.

List CSE identities

Lists a page of client-side encrypted identities and their key-pair associations.

List CSE key pairs

Lists a page of client-side encryption key pairs, including public keys and enablement states.

List Drafts

Retrieves a paginated list of email drafts from a user's Gmail account.

List Gmail filters

Tool to list all Gmail filters (rules) in the mailbox.

List forwarding addresses

Tool to list all forwarding addresses for the specified Gmail account.

List Gmail history

Lists Gmail mailbox change history since a known history ID for incremental sync, with optional label and history-type filters and pagination.

List Gmail labels

Retrieves all system and user-created labels for a Gmail account in a single unpaginated response.

List send-as aliases

Lists the send-as aliases for a Gmail account, including the primary address and custom 'from' aliases.

List S/MIME configs

Lists S/MIME certificate configurations for a specified Gmail send-as alias.

List threads

Retrieves a list of email threads from a Gmail account, identified by `user_id` (email address or 'me'), supporting filtering and pagination.

Modify thread labels

Adds or removes specified existing label IDs from a Gmail thread, affecting all its messages; ensure the thread ID is valid.

Trash thread

Moves the specified thread to the trash.

Move to Trash

Moves an existing, non-deleted email message to the trash for the specified user.

Patch Label

Patches the specified user-created label.

Patch send-as alias

Patches a Gmail send-as alias, including its display name, reply-to address, signature, default status, or SMTP configuration.

Reply to email thread

Sends a reply to a Gmail thread using its original subject and quoting the last returned message.

Search People

Searches saved contacts and optionally Other Contacts by query, returning matching person records.

Send Draft

Sends an existing Gmail draft immediately to the recipients already in its To, Cc, and Bcc headers.

Send Email

Sends an email immediately through Gmail to specified To, Cc, or Bcc recipients, with a subject or body and optional attachments.

Get IMAP Settings

Retrieves the IMAP settings for a Gmail user account, including whether IMAP is enabled, auto-expunge behavior, expunge behavior, and maximum folder size.

Get POP settings

Tool to retrieve POP settings for a Gmail account.

Get send-as alias

Tool to retrieve a specific send-as alias configuration for a Gmail user.

Stop watch notifications

Tool to stop receiving push notifications for a Gmail mailbox.

Untrash Message

Tool to remove a message from trash in Gmail.

Untrash thread

Tool to remove a thread from trash in Gmail.

Update Google Contact

Replace selected fields on an existing saved Google contact.

Update draft

Updates a Gmail draft by ID by replacing its message.

Update IMAP settings

Tool to update IMAP settings for a Gmail account.

Update Label

Updates an existing Gmail label's name, visibility settings, or color to help organize the mailbox.

Update Language Settings

Tool to update the language settings for a Gmail user.

Update POP settings

Tool to update POP settings for a Gmail account.

Update send-as alias

Updates a Gmail send-as alias, including its display name, signature, reply-to address, or SMTP settings; Gmail sanitizes HTML signatures before saving.

Update Vacation Settings

Tool to update vacation responder settings for a Gmail user.

Who Am I

Return the identity (email, name) of the connected Gmail account.

FRAMEWORKS

How to build Gmail MCP Agent with another framework

Claude Code logo

Claude Code

Use Gmail MCP with Claude Code

Cursor logo

Cursor

Use Gmail MCP with Cursor

ChatGPT logo

ChatGPT

Use Gmail MCP with ChatGPT

Claude Cowork logo

Claude Cowork

Use Gmail MCP with Claude Cowork

Antigravity logo

Antigravity

Use Gmail MCP with Antigravity

Claude Agent SDK logo

Claude Agent SDK

Use Gmail MCP with Claude Agent SDK

Grok Bot logo

Grok Bot

Use Gmail MCP with Grok Bot

Muse logo

Muse

Use Gmail MCP with Muse

Codex logo

Codex

Use Gmail MCP with Codex

Kimi Code logo

Kimi Code

Use Gmail MCP with Kimi Code

Grok Build logo

Grok Build

Use Gmail MCP with Grok Build

VS Code logo

VS Code

Use Gmail MCP with VS Code

OpenCode logo

OpenCode

Use Gmail MCP with OpenCode

OpenClaw logo

OpenClaw

Use Gmail MCP with OpenClaw

Hermes logo

Hermes

Use Gmail MCP with Hermes

Atomic Agent logo

Atomic Agent

Use Gmail MCP with Atomic Agent

Pi logo

Pi

Use Gmail MCP with Pi

DeepSeek Harness logo

DeepSeek Harness

Use Gmail MCP with DeepSeek Harness

CLI logo

CLI

Use Gmail MCP with CLI

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

Pydantic AI logo

Pydantic AI

Use Gmail MCP with Pydantic AI

AutoGen logo

AutoGen

Use Gmail MCP with AutoGen

FAQ

Frequently asked questions

With a standalone Gmail MCP server, the agents and LLMs can only access a fixed set of Gmail tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Gmail and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Gmail tools.

Yes, absolutely. You can configure which Gmail scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

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.

Start with Gmail.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Gmail tool your agent needs.Free to start.

Start building