An open API service indexing awesome lists of open source software.

https://github.com/Omar-v2/mcp-ical

A Model Context Protocol Server that allows you to interact with your MacOS Calendar through natural language.
https://github.com/Omar-v2/mcp-ical

icalendar llm mcp mcp-server model-context-protocol

Last synced: about 2 months ago
JSON representation

A Model Context Protocol Server that allows you to interact with your MacOS Calendar through natural language.

Awesome Lists containing this project

README

        

# MCP iCal Server

๐Ÿ—“๏ธ Natural Language Calendar Management for macOS

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-purple.svg)](https://modelcontextprotocol.io)

## ๐ŸŒŸ Overview

Transform how you interact with your macOS calendar using natural language! The mcp-ical server leverages the Model Context Protocol (MCP) to turn your calendar management into a conversational experience.

```
You: "What's my schedule for next week?"
Claude: "Let me check that for you..."
[Displays a clean overview of your upcoming week]

You: "Add a lunch meeting with Sarah tomorrow at noon"
Claude: "โœจ ๐Ÿ“… Created: Lunch with Sarah Tomorrow, 12:00 PM"
```

## โœจ Features

### ๐Ÿ“… Event Creation
Transform natural language into calendar events instantly!

```
"Schedule a team lunch next Thursday at 1 PM at Bistro Garden"
โ†“
๐Ÿ“Ž Created: Team Lunch
๐Ÿ“… Thursday, 1:00 PM
๐Ÿ“ Bistro Garden
```

#### Supported Features:
- Custom calendar selection
- Location and notes
- Smart reminders
- Recurring events

#### Power User Examples:
```
๐Ÿ”„ Recurring Events:
"Set up my weekly team sync every Monday at 9 AM with a 15-minute reminder"

๐Ÿ“ Detailed Events:
"Schedule a product review meeting tomorrow from 2-4 PM in the Engineering calendar,
add notes about reviewing Q1 metrics, and remind me 1 hour before"

๐Ÿ“ฑ Multi-Calendar Support:
"Add a dentist appointment to my Personal calendar for next Wednesday at 3 PM"
```

### ๐Ÿ” Smart Schedule Management & Availability
Quick access to your schedule with natural queries:

```
"What's on my calendar for next week?"
โ†“
๐Ÿ“Š Shows your upcoming events with smart formatting

"When am I free to schedule a 2-hour meeting next Tuesday?"
โ†“
๐Ÿ•’ Available time slots found:
โ€ข Tuesday 10:00 AM - 12:00 PM
โ€ข Tuesday 2:00 PM - 4:00 PM
```

### โœ๏ธ Intelligent Event Updates
Modify events naturally:

```
Before: "Move tomorrow's team meeting to 3 PM instead"
โ†“
After: โœจ Meeting rescheduled to 3:00 PM
```

#### Update Capabilities:
- Time and date modifications
- Calendar transfers
- Location updates
- Note additions
- Reminder adjustments
- Recurring pattern changes

### ๐Ÿ“Š Calendar Management
- View all available calendars
- Smart calendar suggestions
- Seamless Google Calendar integration when configured with iCloud

> ๐Ÿ’ก **Pro Tip**: Since you can create events in custom calendars, if you have your Google Calendar synced with you iCloud Calendar, you can use this MCP server to create events in your Google Calendar too! Just specify the google calendar when creating/updating events

## ๐Ÿš€ Quick Start

> ๐Ÿ’ก **Note**: While these instructions focus on setting up the MCP server with Claude for Desktop, this server can be used with any MCP-compatible client. For more details on using different clients, see [the MCP documentation](https://modelcontextprotocol.io/quickstart/client).

### Prerequisites
- [uv package manager](https://github.com/astral-sh/uv)
- macOS with Calendar app configured
- An MCP client - [Claude for desktop](https://claude.ai/download) is recommend

### Installation

Whilst this MCP server can be used with any MCP compatible client, the instructions below are for use with Claude for desktop.

1. **Clone and Setup**
```bash
# Clone the repository
git clone https://github.com/yourusername/mcp-ical.git
cd mcp-ical

# Install dependencies
uv sync
```

2. **Configure Claude for Desktop**

Create or edit `~/Library/Application\ Support/Claude/claude_desktop_config.json`:

```json
{
"mcpServers": {
"mcp-ical": {
"command": "uv",
"args": [
"--directory",
"/ABSOLUTE/PATH/TO/PARENT/FOLDER/mcp-ical",
"run",
"mcp-ical"
]
}
}
}
```

3. **Launch Claude for Calendar Access**

> โš ๏ธ **Critical**: Claude must be launched from the terminal to properly request calendar permissions. Launching directly from Finder will not trigger the permissions prompt.

```bash
/Applications/Claude.app/Contents/MacOS/Claude
```

4. **Start Using!**
```
Try: "What's my schedule looking like for next week?"
```

> ๐Ÿ”‘ **Note**: When you first use a calendar-related command, macOS will prompt for calendar access. This prompt will only appear if you launched Claude from the terminal as specified above.
## ๐Ÿงช Testing

> โš ๏ธ **Warning**: Tests will create temporary calendars and events. While cleanup is automatic, only run tests in development environments.

```bash
# Install dev dependencies
uv sync --dev

# Run test suite
uv run pytest tests
```

## ๐Ÿ› Known Issues

### Recurring Events
- Non-standard recurring schedules may not always be set correctly
- Better results with Claude 3.5 Sonnet compared to Haiku
- Reminder timing for recurring all-day events may be off by one day

## ๐Ÿค Contributing

Feedback and contributions are welcomed! Here's how you can help:

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

## ๐Ÿ“ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ๐Ÿ™ Acknowledgments

- Built with [Model Context Protocol](https://modelcontextprotocol.io)
- MacOS Calendar integration built with [PyObjC](https://github.com/ronaldoussoren/pyobjc)