MCP Headless Gmail Server
MCP Headless Gmail-сервер
Сервер MCP (Model Context Protocol), который обеспечивает получение и отправку писем Gmail без локальной настройки учетных данных или токена.
Почему стоит выбрать MCP Headless Gmail Server?
Критические преимущества
Автономная и удаленная работа : в отличие от других решений MCP Gmail, требующих запуска вне Docker и доступа к локальным файлам, этот сервер может работать полностью автономно в удаленных средах без браузера и доступа к локальным файлам.
Разделенная архитектура : любой клиент может независимо завершить поток OAuth, а затем передать учетные данные в качестве контекста на этот сервер MCP, создавая полное разделение между хранилищем учетных данных и реализацией сервера.
Неплохо, но не критично
Специализированная функциональность : во многих случаях использования, особенно для маркетинговых приложений, требуется только доступ к Gmail без дополнительных служб Google, таких как Календарь, что делает эту специализированную реализацию идеальной.
Docker-Ready : разработан с учетом контейнеризации для надежной изоляции, независимой от среды и настройки в один клик.
Надежные зависимости : построено на хорошо поддерживаемой библиотеке google-api-python-client.
Related MCP server: MCP Headless Gmail Server
Функции
Получайте последние письма из Gmail с первыми 1000 символами текста
Получите полный текст письма частями по 1 тыс. с помощью параметра offset
Отправка писем через Gmail
Обновите токены доступа по отдельности
Автоматическая обработка токенов обновления
Предпосылки
Python 3.10 или выше
Учетные данные API Google (идентификатор клиента, секрет клиента, токен доступа и токен обновления)
Установка
# Clone the repository
git clone https://github.com/baryhuang/mcp-headless-gmail.git
cd mcp-headless-gmail
# Install dependencies
pip install -e .Докер
Создание образа Docker
# Build the Docker image
docker build -t mcp-headless-gmail .Использование с Claude Desktop
Вы можете настроить Claude Desktop для использования образа Docker, добавив в конфигурацию Claude следующее:
докер
{
"mcpServers": {
"gmail": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"buryhuang/mcp-headless-gmail:latest"
]
}
}
}npm-версия
{
"mcpServers": {
"gmail": {
"command": "npx",
"args": [
"@peakmojo/mcp-server-headless-gmail"
]
}
}
}Примечание: При такой конфигурации вам необходимо предоставить учетные данные Google API в вызовах инструментов, как показано в разделе «Использование инструментов» . Учетные данные Gmail не передаются как переменные среды для поддержания разделения между хранилищем учетных данных и реализацией сервера.
Кросс-платформенная публикация
Чтобы опубликовать образ Docker для нескольких платформ, вы можете использовать команду docker buildx . Выполните следующие действия:
Создайте новый экземпляр конструктора (если вы еще этого не сделали):
docker buildx create --useСоздайте и распространите образ на несколько платформ :
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t buryhuang/mcp-headless-gmail:latest --push .Убедитесь, что изображение доступно для указанных платформ :
docker buildx imagetools inspect buryhuang/mcp-headless-gmail:latest
Использование
Сервер обеспечивает функциональность Gmail через инструменты MCP. Обработка аутентификации упрощается с помощью специального инструмента обновления токенов.
Запуск сервера
mcp-server-headless-gmailИспользование инструментов
При использовании MCP-клиента, такого как Claude, у вас есть два основных способа выполнения аутентификации:
Обновление токенов (первый шаг или по истечении срока действия токенов)
Если у вас есть и токены доступа, и токены обновления:
{
"google_access_token": "your_access_token",
"google_refresh_token": "your_refresh_token",
"google_client_id": "your_client_id",
"google_client_secret": "your_client_secret"
}Если срок действия вашего токена доступа истек, вы можете обновить его, используя только токен обновления:
{
"google_refresh_token": "your_refresh_token",
"google_client_id": "your_client_id",
"google_client_secret": "your_client_secret"
}Это вернет новый токен доступа и время его действия, которые вы сможете использовать для последующих вызовов.
Получение последних писем
Извлекает последние электронные письма с первыми 1000 символами каждого текста электронного письма:
{
"google_access_token": "your_access_token",
"max_results": 5,
"unread_only": false
}Ответ включает в себя:
Метаданные электронной почты (id, threadId, от, кому, тема, дата и т. д.)
Первые 1000 символов текста письма
body_size_bytes: Общий размер тела письма в байтах.contains_full_body: логическое значение, указывающее, включено ли все тело (true) или усечено (false)
Получение полного содержания электронного письма
Для писем, текст которых превышает 1 тыс. символов, вы можете извлечь все содержимое по частям:
{
"google_access_token": "your_access_token",
"message_id": "message_id_from_get_recent_emails",
"offset": 0
}Вы также можете получить содержимое письма по идентификатору темы:
{
"google_access_token": "your_access_token",
"thread_id": "thread_id_from_get_recent_emails",
"offset": 1000
}Ответ включает в себя:
Фрагмент текста письма размером 1 КБ, начинающийся с указанного смещения
body_size_bytes: Общий размер тела письмаchunk_size: Размер возвращаемого фрагментаcontains_full_body: логическое значение, указывающее, содержит ли фрагмент оставшуюся часть тела
Чтобы получить весь текст длинного сообщения, выполните последовательные вызовы, увеличивая смещение на 1000 каждый раз, пока contains_full_body не станет истинным.
Отправка электронного письма
{
"google_access_token": "your_access_token",
"to": "recipient@example.com",
"subject": "Hello from MCP Gmail",
"body": "This is a test email sent via MCP Gmail server",
"html_body": "<p>This is a <strong>test email</strong> sent via MCP Gmail server</p>"
}Рабочий процесс обновления токена
Начните с вызова инструмента
gmail_refresh_tokenодним из следующих способов:Ваши полные учетные данные (токен доступа, токен обновления, идентификатор клиента и секрет клиента) или
Только ваш токен обновления, идентификатор клиента и секретный ключ клиента, если срок действия токена доступа истек
Используйте возвращенный новый токен доступа для последующих вызовов API.
Если вы получили ответ, указывающий на истечение срока действия токена, вызовите инструмент
gmail_refresh_tokenеще раз, чтобы получить новый токен.
Такой подход упрощает большинство вызовов API, поскольку не требует ввода учетных данных клиента для каждой операции, но при этом позволяет обновлять токены при необходимости.
Получение учетных данных Google API
Чтобы получить необходимые учетные данные Google API, выполните следующие действия:
Перейдите в Google Cloud Console.
Создать новый проект
Включить API Gmail
Настроить экран согласия OAuth
Создайте учетные данные идентификатора клиента OAuth (выберите «Приложение для настольного компьютера» в качестве типа приложения)
Сохраните идентификатор клиента и секрет клиента.
Используйте OAuth 2.0 для получения доступа и обновления токенов в следующих областях:
https://www.googleapis.com/auth/gmail.readonly(для чтения писем)https://www.googleapis.com/auth/gmail.send(для отправки писем)
Обновление токена
Этот сервер реализует автоматическое обновление токена. Когда срок действия вашего токена доступа истекает, клиент API Google будет использовать токен обновления, идентификатор клиента и секрет клиента для получения нового токена доступа без необходимости вмешательства пользователя.
Примечание по безопасности
Этот сервер требует прямого доступа к вашим учетным данным Google API. Всегда храните свои токены и учетные данные в безопасности и никогда не делитесь ими с недоверенными сторонами.
Лицензия
Подробную информацию смотрите в файле ЛИЦЕНЗИЯ.
Available Tools
4 toolsgmail_get_email_body_chunkB
Get a 1k character chunk of an email body starting from the specified offset
| Name | Required | Description | Default |
|---|---|---|---|
| google_access_token | Yes | Google OAuth2 access token | |
| message_id | No | ID of the message to retrieve | |
| thread_id | No | ID of the thread to retrieve (will get the first message if multiple exist) | |
| offset | No | Offset in characters to start from (default: 0) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. It mentions the 1k character chunking behavior, which is valuable, but doesn't address authentication needs (though implied by google_access_token parameter), error handling, rate limits, or what happens with invalid offsets/message_ids. For a tool with no annotation coverage, this leaves significant gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that immediately conveys the core functionality without any wasted words. It's appropriately sized and front-loaded with the essential information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's moderate complexity (4 parameters, no output schema, no annotations), the description is minimally adequate. It explains the chunking behavior but lacks details about authentication requirements, error conditions, and how this tool relates to siblings. Without annotations or output schema, more behavioral context would be helpful for safe usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so parameters are well-documented in the schema. The description adds context about the 'offset' parameter (default: 0) and clarifies that thread_id retrieves the first message if multiple exist, providing some value beyond the schema. However, it doesn't explain parameter interactions or provide additional semantic context.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Get'), resource ('email body chunk'), and key constraint ('1k character chunk starting from specified offset'), making the purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like gmail_get_recent_emails, which retrieves multiple emails rather than a specific body chunk.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided about when to use this tool versus alternatives. The description doesn't mention prerequisites (like needing a message_id or thread_id), nor does it explain when this tool is appropriate compared to gmail_get_recent_emails for retrieving email content.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
gmail_get_recent_emailsC
Get the most recent emails from Gmail (returns metadata, snippets, and first 1k chars of body)
| Name | Required | Description | Default |
|---|---|---|---|
| google_access_token | Yes | Google OAuth2 access token | |
| max_results | No | Maximum number of emails to return (default: 10) | |
| unread_only | No | Whether to return only unread emails (default: False) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. It mentions what data is returned (metadata, snippets, first 1k chars of body) which is helpful, but doesn't cover important behavioral aspects like authentication requirements (beyond the parameter), rate limits, pagination behavior, error conditions, or whether this is a read-only operation. For a tool with no annotations, this leaves significant gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that communicates the core functionality and return format. It's appropriately sized for a straightforward retrieval tool, though it could potentially benefit from slightly more detail given the lack of annotations and output schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of email retrieval (3 parameters, no annotations, no output schema), the description is insufficiently complete. It doesn't explain the return format in detail, doesn't mention authentication requirements beyond the parameter, and doesn't cover important behavioral aspects. For a tool with no annotations or output schema, the description should provide more context about what to expect from the operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents all three parameters. The description doesn't add any parameter-specific information beyond what's in the schema. The baseline of 3 is appropriate when the schema does all the parameter documentation work.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Get the most recent emails from Gmail' specifies the verb (get) and resource (emails). It distinguishes from sibling 'gmail_get_email_body_chunk' by indicating it returns metadata, snippets, and partial body content, but doesn't explicitly differentiate from other siblings like 'gmail_send_email' or 'gmail_refresh_token' beyond the obvious functional difference.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance on when to use this tool versus alternatives is provided. The description doesn't mention when to use this versus 'gmail_get_email_body_chunk' for full body retrieval, or when to use 'gmail_refresh_token' for token management. Usage context is implied by the tool name but not explicitly stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
gmail_refresh_tokenB
Refresh the access token using the refresh token and client credentials
| Name | Required | Description | Default |
|---|---|---|---|
| google_access_token | No | Google OAuth2 access token (optional if expired) | |
| google_refresh_token | Yes | Google OAuth2 refresh token | |
| google_client_id | Yes | Google OAuth2 client ID for token refresh | |
| google_client_secret | Yes | Google OAuth2 client secret for token refresh |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden but only states what the tool does at a high level. It doesn't disclose behavioral traits like whether this invalidates previous tokens, rate limits, error conditions, or what the refreshed token enables. For a security-sensitive operation with zero annotation coverage, this is inadequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that directly states the tool's purpose with zero waste. It's appropriately sized and front-loaded, with every word contributing to understanding the core functionality.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a security-critical token refresh operation with no annotations and no output schema, the description is insufficient. It doesn't explain what happens after refresh (e.g., token lifetime, scope preservation), error handling, or integration with sibling tools. Given the complexity and lack of structured data, more context is needed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all 4 parameters thoroughly. The description adds no parameter-specific semantics beyond what's in the schema (e.g., it doesn't explain relationships between parameters or provide usage examples). Baseline 3 is appropriate when schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('Refresh') and resource ('access token'), specifying it uses refresh token and client credentials. It distinguishes from sibling tools (email-related operations) by focusing on authentication token management, though it doesn't explicitly name alternatives for token refresh.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when access tokens expire (via 'optional if expired' in schema), but doesn't explicitly state when to use this tool versus alternatives like initial authentication or other token management methods. No guidance on prerequisites or exclusions is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
gmail_send_emailC
Send an email via Gmail
| Name | Required | Description | Default |
|---|---|---|---|
| google_access_token | Yes | Google OAuth2 access token | |
| to | Yes | Recipient email address | |
| subject | Yes | Email subject | |
| body | Yes | Email body content (plain text) | |
| html_body | No | Email body content in HTML format (optional) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action ('send an email') but lacks critical details: it doesn't mention authentication requirements (implied by the 'google_access_token' parameter but not explicitly stated), potential rate limits, error handling, or what happens upon success (e.g., whether it returns a confirmation). This leaves significant gaps for a mutation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero wasted words—'Send an email via Gmail' is front-loaded and directly conveys the core action. It's appropriately sized for the tool's complexity, making it easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (a mutation tool with 5 parameters, no annotations, and no output schema), the description is incomplete. It fails to address key contextual aspects like authentication needs, behavioral traits (e.g., what 'send' entails operationally), or output expectations, leaving the agent with insufficient information for reliable use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, with all parameters well-documented in the schema (e.g., 'to' as recipient email, 'body' as plain text content). The description adds no additional meaning beyond the schema, such as explaining parameter interactions (e.g., 'body' vs. 'html_body') or constraints. This meets the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Send an email via Gmail' clearly states the verb ('send') and resource ('email via Gmail'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'gmail_get_recent_emails' or 'gmail_refresh_token' beyond the obvious action distinction, which keeps it from a perfect score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing authentication via 'google_access_token'), nor does it clarify scenarios where other tools like 'gmail_get_recent_emails' might be more appropriate, leaving usage context entirely implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
4 tool updates
- First observed
gmail_get_email_body_chunk - First observed
gmail_get_recent_emails - First observed
gmail_refresh_token - First observed
gmail_send_email
TDQS
Scored across 4 tools
Each tool has a clearly distinct purpose: retrieving email body chunks, listing recent emails, refreshing tokens, and sending emails. There is no overlap in functionality that would cause confusion or misselection.
All tools follow a consistent 'gmail_verb_noun' pattern with snake_case, making them predictable and easy to understand. The naming convention is uniform across all four tools.
With 4 tools, the count is reasonable for a Gmail server, though it feels slightly thin for covering all common email operations. It includes core functions but could benefit from additional tools like searching or managing drafts.
The tools cover basic email operations (read, list, send) and authentication, but there are notable gaps such as searching emails, managing labels, or handling attachments. This could limit agents in performing more complex email tasks.
Maintenance
Related MCP Connectors
Manage Gmail end-to-end: search, read, send, draft, label, and organize threads. Automate workflow…
Never-stored live email: read, send, organize, schedule and auto-triage Gmail or any IMAP mailbox.
Permissioned access to Gmail, Drive and Calendar via the user's own Google account
A MCP server for Gmail that lets you search, read, and draft emails and replies.
Related MCP Servers
- AlicenseNot gradedqualityNot gradedmaintenanceA Model Context Protocol server that enables applications to interact with Gmail through a clean API, supporting email searching, sending, reading, and label management.MIT
- AlicenseBqualityDmaintenanceEnables reading and sending Gmail messages in headless/remote environments without local credential storage, using OAuth tokens passed directly in API calls for containerized deployments.362 npmMIT
- AlicenseNot gradedqualityBmaintenanceEnables reading, sending, archiving, and managing Gmail emails and labels through Google OAuth authentication, acting as an OAuth proxy to the Gmail API.150 npm11MIT
- AlicenseNot gradedqualityDmaintenanceA Model Context Protocol server that exposes the Gmail API for integration with LLMs, enabling email management tasks such as reading, labeling, and searching emails.7MIT