1.0.2 • Published 12 months ago

@gongrzhe/server-calendar-autoauth-mcp v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
12 months ago

Calendar MCP Server

A Model Context Protocol (MCP) server for Google Calendar integration in Cursor IDE with auto authentication support. This server enables AI assistants to manage Google Calendar events through natural language interactions.

npm version License: ISC

Features

  • Create calendar events with title, time, description, and location
  • Retrieve event details by event ID
  • Update existing events (title, time, description, location)
  • Delete events
  • List events within a specified time range
  • Full integration with Google Calendar API
  • Simple OAuth2 authentication flow with auto browser launch

Installation & Authentication

  1. Create a Google Cloud Project and obtain credentials:

    a. Create a Google Cloud Project:

    • Go to Google Cloud Console
    • Create a new project or select an existing one
    • Enable the Google Calendar API for your project

    b. Create OAuth 2.0 Credentials:

    • Go to "APIs & Services" > "Credentials"
    • Click "Create Credentials" > "OAuth client ID"
    • Choose "Desktop app" as application type
    • Give it a name and click "Create"
    • Download the JSON file of your client's OAuth keys
    • Rename the key file to gcp-oauth.keys.json
  2. Run Authentication:

    You can authenticate in two ways:

    a. Global Authentication (Recommended):

    # First time: Place gcp-oauth.keys.json in your home directory's .calendar-mcp folder
    mkdir -p ~/.calendar-mcp
    mv gcp-oauth.keys.json ~/.calendar-mcp/
    
    # Run authentication from anywhere
    npx @gongrzhe/server-calendar-autoauth-mcp auth

    b. Local Authentication:

    # Place gcp-oauth.keys.json in your current directory
    # The file will be automatically copied to global config
    npx @gongrzhe/server-calendar-autoauth-mcp auth

    The authentication process will:

    • Look for gcp-oauth.keys.json in the current directory or ~/.calendar-mcp/
    • If found in current directory, copy it to ~/.calendar-mcp/
    • Open your default browser for Google authentication
    • Save credentials as ~/.calendar-mcp/credentials.json

    Note: After successful authentication, credentials are stored globally in ~/.calendar-mcp/ and can be used from any directory.

  3. Configure in Cursor Desktop:

{
  "mcpServers": {
    "calendar": {
      "command": "npx",
      "args": [
        "@gongrzhe/server-calendar-autoauth-mcp"
      ]
    }
  }
}

Docker Support

If you prefer using Docker:

  1. Authentication:
docker run -i --rm \
  --mount type=bind,source=/path/to/gcp-oauth.keys.json,target=/gcp-oauth.keys.json \
  -v mcp-calendar:/calendar-server \
  -e CALENDAR_OAUTH_PATH=/gcp-oauth.keys.json \
  -e "CALENDAR_CREDENTIALS_PATH=/calendar-server/credentials.json" \
  -p 3000:3000 \
  mcp/calendar auth
  1. Usage:
{
  "mcpServers": {
    "calendar": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v",
        "mcp-calendar:/calendar-server",
        "-e",
        "CALENDAR_CREDENTIALS_PATH=/calendar-server/credentials.json",
        "mcp/calendar"
      ]
    }
  }
}

Usage Examples

The server provides several tools that can be used through the Cursor IDE:

Create Event

{
  "summary": "Team Meeting",
  "start": {
    "dateTime": "2024-01-20T10:00:00Z"
  },
  "end": {
    "dateTime": "2024-01-20T11:00:00Z"
  },
  "description": "Weekly team sync",
  "location": "Conference Room A"
}

List Events

{
  "timeMin": "2024-01-01T00:00:00Z",
  "timeMax": "2024-12-31T23:59:59Z",
  "maxResults": 10,
  "orderBy": "startTime"
}

Update Event

{
  "eventId": "event123",
  "summary": "Updated Meeting Title",
  "start": {
    "dateTime": "2024-01-20T11:00:00Z"
  },
  "end": {
    "dateTime": "2024-01-20T12:00:00Z"
  }
}

Delete Event

{
  "eventId": "event123"
}

Security Notes

  • OAuth credentials are stored securely in your local environment
  • The server uses offline access to maintain persistent authentication
  • Never share or commit your credentials to version control
  • Regularly review and revoke unused access in your Google Account settings

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the ISC License.

Author

gongrzhe

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.