yagms

yagms

又一个 Gmail MCP 服务

设置与使用

Gmail MCP 服务

Gmail MCP 服务通过 Model Context Protocol（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 # It will emit ./dist/gmail.js

身份验证

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

# Run the authentication flow
bun run dist/gmail.js auth

此操作将：

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

运行服务

完成身份验证后，你可以运行 Gmail MCP 服务：

# Run the server
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:[email protected] 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": []
    }
  }
}