yagms

又一个 Gmail MCP 服务器

设置和使用

Gmail MCP 服务器

Gmail MCP 服务器提供通过模型上下文协议 (MCP) 与您的 Gmail 帐户交互的工具。

前提条件

1. 为 Gmail API 创建 OAuth 凭据：
   • 前往 Google Cloud Console
   • 创建一个新项目或选择一个现有项目
   • 启用 Gmail API
   • 创建 OAuth 2.0 凭据（桌面应用程序）
   • 下载凭据 JSON 文件并将其保存为 ~/.yagms-oauth.keys.json

构建此项目

1. 安装 Bun。
2. 构建代码

bun install
bun run build-gmail # 它将生成 ./dist/gmail.js

身份验证

在使用 Gmail MCP 服务器之前，您需要使用您的 Google 帐户进行身份验证：

# 运行身份验证流程
bun run dist/gmail.js auth

这将：

• 启动一个浏览器窗口，供您登录您的 Google 帐户
• 请求访问您的 Gmail 帐户的权限
• 将身份验证凭据保存到 ~/.yagms-credentials.json

运行服务器

身份验证后，您可以运行 Gmail MCP 服务器：

# 运行服务器
bun run src/gmail.ts

配置

您可以使用环境变量自定义 OAuth 密钥和凭据的路径：

• GMAIL_OAUTH_PATH: OAuth 密钥文件的路径（默认：~/.yagms-oauth.keys.json）
• GMAIL_CREDENTIALS_PATH: 保存凭据的路径（默认：~/.yagms-credentials.json）

可用工具

Gmail MCP 服务器提供以下工具：

1. list-emails: 从您的收件箱获取电子邮件

   • 参数：
     • senderEmail（可选）：按发件人电子邮件过滤
     • maxResults（可选，默认：10）：要返回的最大电子邮件数量
     • labelIds（可选，默认：["INBOX"]）：要过滤的标签 ID

2. get-email: 按 ID 获取特定电子邮件

   • 参数：
     • emailId: 要检索的电子邮件的 ID

3. search-emails: 使用 Gmail 搜索语法搜索电子邮件

   • 参数：
     • query: Gmail 搜索查询（例如，“from:example@gmail.com has:attachment”）
     • maxResults（可选，默认：10）：要返回的最大电子邮件数量

4. get-labels: 获取所有 Gmail 标签

   • 无需参数

示例 MCP 配置

将其添加到您的 MCP 设置文件中：

{
  "mcpServers": {
    "gmail": {
      "command": "bun",
      "args": ["run", "/path/to/yagms/dist/gmail.js"],
      "env": {},
      "disabled": false,
      "autoApprove": []
    }
  }
}