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 或其他工具自動測試和構建。
• 文檔更新：定期更新用戶指南和開發者文檔。
• 性能優化：提升日曆操作效率，降低資源消耗。