使用说明

项目简介

Teague 是一个基于 Model Context Protocol (MCP) 构建的邮件管理应用后端，作为一个 MCP 服务器运行，它允许大型语言模型 (LLM) 客户端与用户的 Gmail 和 Google 日历进行交互。

主要功能点

• 资源管理: 托管和管理用户的 Gmail 邮箱和 Google 日历资源。
• 工具执行: 提供一系列工具，允许 LLM 客户端执行各种邮件操作（例如，创建草稿回复、存档邮件、过滤发件人、取消订阅、发送邮件等）和日历事件操作（例如，接受日历邀请）。
• Prompt 模板: 集成了 Langfuse，用于管理和定制 Prompt 模板，以便更灵活地控制 LLM 与邮件内容的交互方式。
• MCP 服务器: 实现了 Model Context Protocol，可以通过标准化的 JSON-RPC 协议与 MCP 客户端进行通信。

安装步骤

1. 安装 Bun: 请根据 bun.sh 官方文档 安装 Bun 运行时环境。
2. 配置 Google Cloud 项目和 Gmail API:
   • 在 Google Cloud Console 中创建一个项目。
   • 启用 Gmail API。
   • 创建 OAuth 2.0 客户端 ID，并下载 'credentials.json' 文件。
   • 将下载的 'credentials.json' 文件放置在 'packages/auth/credentials.json' 路径下。
3. 生成 token.json:
   • 打开终端，导航到 'packages/auth' 目录：'cd packages/auth'
   • 安装项目依赖：'bun install'
   • 运行脚本生成 'token.json' 文件：'bun run index.ts'

服务器配置

MCP 服务器需要配置启动命令和参数才能被 MCP 客户端调用。以下是 Teague Gmail MCP 服务器的配置信息，请将其配置到您的 MCP 客户端中：

{
  "serverName": "gmail",
  "command": "bun",
  "args": [
    "run",
    "chat-with",
    "gmail"
  ],
  "description": "启动 Gmail MCP 服务器，用于与用户的电子邮件进行交互。"
}

基本使用方法

1. 启动 MCP 服务器: Teague 项目本身作为 MCP 服务器，通过上述配置，您可以将其启动命令配置到 MCP 客户端中。
2. 连接 MCP 客户端: 使用任何兼容 Model Context Protocol 的 LLM 客户端（例如 Claude Desktop, Cursor, MCP Inspector）。
3. 配置客户端连接: 在 MCP 客户端中，配置上述 'serverName', 'command' 和 'args' 等信息，建立与 Teague Gmail MCP 服务器的连接。
4. 使用工具: 连接成功后，LLM 客户端即可通过 MCP 协议调用 Teague 服务器提供的各种工具，例如：
   • 让 LLM 客户端调用 'CreateDraftReply' 工具来基于邮件内容创建回复草稿。
   • 使用 'ArchiveEmail' 工具来存档指定邮件。
   • 调用 'AcceptInvite' 工具来接受 Google 日历邀请。