Google Calendar MCP

🚀 Google Calendar 日历 MCP 服务器

Google Calendar 日历 MCP 服务器是一个可本地运行的工具，它能与 Google Calendar 集成。借助 OAuth 2.0 进行身份验证，还提供命令行接口 (CLI) 来管理和操作日历数据。

🚀 快速开始

若想快速上手 Google Calendar 日历 MCP 服务器，可按以下步骤操作：

1. 克隆仓库

   git clone <repository-url>
   cd google-calendar-mcp-server
   

2. 安装依赖

   npm install
   

3. 启动服务器（开发模式）

   npm start
   

✨ 主要特性

• 日历管理：支持创建、读取、更新和删除日历。
• 事件操作：可添加、查询、更新和取消事件。
• OAuth 2.0 支持：通过 Google 账户进行身份验证。
• 本地运行：无需服务器，直接在本机运行。

📦 安装指南

安装依赖

1. 克隆仓库

   git clone <repository-url>
   cd google-calendar-mcp-server
   

2. 安装 Node.js 和 npm
   • 确保安装 Node.js 版本在 14 或更高。
   • 安装 npm：通常随 Node.js 一起安装。
3. 安装项目依赖

   npm install
   

启动服务器

开发模式启动

npm start

生产模式启动

node build/index.js

💻 使用示例

基础用法

配置指南

• 创建配置文件：在项目根目录下创建 config.json：

{
  "googleCalendar": {
    "clientId": "YOUR_GOOGLE_CLIENT_ID",
    "clientSecret": "YOUR_GOOGLE_CLIENT_SECRET",
    "redirectUri": "http://localhost:3000"
  }
}

• 环境变量配置（推荐）：设置以下环境变量：

export GOOGLE_CLIENT_ID=your_client_id
export GOOGLE_CLIENT_SECRET=your_client_secret
export REDIRECT_URI=http://localhost:3000

认证流程

• 自动化认证：运行服务器时，会自动启动一个临时服务器以处理 OAuth 重定向。完成认证后，访问令牌和刷新令牌将保存到 .google-credentials.json 文件中。
• 手动认证：

npm run auth

此命令启动浏览器，引导用户完成 Google 账户的 OAuth 认证流程。

日历操作

• 创建日历：使用 createCalendar 命令：

node build/index.js createCalendar --name "My New Calendar"

• 获取所有日历：列出所有已配置的日历：

node build/index.js listCalendars

📚 详细文档

命令行接口 (CLI)

完整的 CLI 文档请参阅 项目文档。

开发文档

详细的技术文档，请查阅 开发者指南。

🔧 技术细节

项目结构

google-calendar-mcp-server/
├── src/                 # 源代码文件夹
│   ├── index.ts        # 入口文件
│   ├── calendar.ts     # 日历业务逻辑
│   └── event.ts       # 事件处理逻辑
├── build/              # 构建输出目录
│   └── index.js       # 启动入口
└── config.json         # 配置文件示例

核心模块

src/calendar.ts

负责日历的 CRUD 操作，集成 Google Calendar API。

src/event.ts

处理事件的创建、查询和删除操作，依赖于日历模块。

📄 许可证

项目采用 MIT 许可证，具体条款见 LICENSE 文件。

🌟 贡献指南

欢迎贡献！请参考 贡献者指南，了解如何参与开发和提交代码。

📅 计划任务

• 持续集成（CI）：使用 GitHub Actions 或其他工具自动测试和构建。
• 文档更新：定期更新用户指南和开发者文档。
• 性能优化：提升日历操作效率，降低资源消耗。