Google Calendar MCP

🚀 Google Calendar MCP Server

The Google Calendar MCP (Maybe referring to "Minimal Configuration Package" or other specific terms? In the context, it may specifically refer to a custom protocol or module) Server is a locally run tool designed to integrate with Google Calendar. It authenticates via OAuth 2.0 and offers a Command Line Interface (CLI) to manage and manipulate calendar data.

🚀 Quick Start

Prerequisites

• Ensure Node.js version 14 or higher is installed.
• npm is usually installed along with Node.js.

Installation

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

Starting the Server

• Development Mode:

npm start

• Production Mode:

node build/index.js

✨ Features

• Calendar Management: Create, read, update, and delete calendars.
• Event Operations: Add, query, update, and cancel events.
• OAuth 2.0 Support: Authenticate via Google accounts.
• Local Execution: Run directly on your local machine without the need for a server.

📦 Installation

Installing Dependencies

1. Clone the Repository

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

2. Install Node.js and npm
   • Make sure Node.js version 14 or higher is installed.
   • npm is typically installed with Node.js.
3. Install Project Dependencies

   npm install
   

💻 Usage Examples

Starting the Server

Development Mode

npm start

Production Mode

node build/index.js

Calendar Operations

Create a Calendar

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

List All Calendars

node build/index.js listCalendars

📚 Documentation

User Guide

Quick Start

1. Clone the Repository

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

2. Install Dependencies

   npm install
   

3. Start the Server (Development Mode)

   npm start
   

Configuration Guide

Create a Configuration File

Create a config.json in the project root directory:

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

Environment Variable Configuration (Recommended)

Set the following environment variables:

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

Authentication Process

Automated Authentication

When starting the server, a temporary server will automatically start to handle OAuth redirects. After authentication, the access token and refresh token will be saved in the .google-credentials.json file.

Manual Authentication

npm run auth

This command launches a browser to guide you through the Google account OAuth authentication process.

Development Guide

Project Structure

google-calendar-mcp-server/
├── src/                 # Source code folder
│   ├── index.ts        # Entry file
│   ├── calendar.ts     # Calendar business logic
│   └── event.ts       # Event handling logic
├── build/              # Build output directory
│   └── index.js       # Startup entry
└── config.json         # Configuration file example

Core Modules

• src/calendar.ts: Responsible for CRUD operations on calendars and integrates the Google Calendar API.
• src/event.ts: Handles event creation, query, and deletion operations, relying on the calendar module.

Command Line Interface (CLI)

Refer to the Project Documentation for the full CLI documentation.

Development Documentation

Check the Developer Guide for detailed technical documentation.

🔧 Technical Details

Core Modules

• src/calendar.ts: This module is responsible for the CRUD operations of calendars and integrates the Google Calendar API.
• src/event.ts: It handles the creation, query, and deletion of events, relying on the calendar module.

🤝 Contribution Guide

Contributions are welcome! Please refer to the Contributor Guide to learn how to participate in development and submit code.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.