Metadata-Version: 2.4
Name: iflow-mcp_chenningling-mcp-applereminders
Version: 0.1.0
Summary: Apple Reminders MCP Server - Create and query Apple Reminders through MCP protocol
Author: chenningling
License: MIT
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: mcp>=1.8.1
Requires-Dist: pydantic>=2.11.4
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: websockets>=11.0.3
Description-Content-Type: text/markdown

# 苹果提醒事项 MCP 工具使用说明

这个工具基于小智AI的MCP功能进行开发(开发示例文档见：[mcp-calculator](https://github.com/78/mcp-calculator))，允许通过 MCP 协议创建和查询苹果提醒事项，可以设置提醒内容（标题和备注）以及提醒日期时间。

## 功能特点

### 创建提醒事项

- 设置提醒标题（必填）
- 添加提醒备注（选填）
- 设置提醒日期（选填，格式：YYYY-MM-DD）
- 设置提醒时间（选填，格式：HH:MM:SS，需要提供日期才有效）

### 查询提醒事项

- 按日期范围查询提醒事项（如"今天"、"明天"、"本周"等）
- 获取提醒事项的完整信息（标题、备注、日期时间）
- 支持自然语言日期表达（如"今天"、"明天"、"周五"等）

## 安装与配置

1. 确保已安装所需依赖：

```bash
pip install -r requirements.txt
```

2. 设置环境变量：

```bash
export MCP_ENDPOINT=<your_mcp_endpoint>
```

## 使用方法

### 1. 启动 MCP 服务器

使用 `mcp_pipe.py` 启动提醒事项服务器：

```bash
python mcp_pipe.py reminder.py
```

### 2. 通过 AI 助手使用提醒事项工具

一旦服务器启动并连接到 AI 助手，您可以通过自然语言使用提醒事项工具：

#### 创建提醒事项

- "帮我创建一个提醒事项，标题是'买牛奶'，备注是'超市特价'，日期是明天"
- "设置一个提醒，标题是'医生预约'，日期是2025年5月20日，时间是下午3点"
- "添加一个提醒：周五下午2:30开会"

#### 查询提醒事项

- "查询我今天的提醒事项"
- "明天有哪些提醒事项？"
- "列出本周的所有提醒"
- "查看5月20日的提醒事项"
- "周五有什么提醒？"

## 测试工具

### 测试创建提醒事项

您可以使用提供的测试脚本来测试提醒事项创建功能：

```bash
python test_reminder.py
```

### 测试查询提醒事项

您可以使用提供的测试脚本来测试提醒事项查询功能：

```bash
python test_get_reminders.py
```

创建提醒事项的测试脚本将运行几个测试用例，包括：
1. 创建没有日期的提醒事项
2. 创建只有日期的提醒事项
3. 创建有日期和时间的提醒事项

查询提醒事项的测试脚本将运行以下测试用例：
1. 查询今天的提醒事项
2. 查询明天的提醒事项
3. 查询本周的提醒事项

## 故障排除

### 常见问题

1. **权限问题**：确保您的应用有权限访问提醒事项。首次运行时可能会弹出权限请求对话框。

2. **日期格式错误**：确保日期格式为 YYYY-MM-DD（例如 2025-05-18）。

3. **时间格式错误**：确保时间格式为 HH:MM:SS（例如 14:30:00）。

### 调试

如果遇到问题，可以查看日志输出以获取更多信息。日志会显示在终端中。

## 功能测试

在真机上测试此功能时，请注意以下几点：

1. **基本功能测试**：
   - 创建不同类型的提醒事项（无日期、有日期、有日期和时间）
   - 验证提醒事项是否正确显示在苹果提醒事项应用中

2. **边界情况测试**：
   - 测试特殊字符在标题和备注中的处理
   - 测试过去的日期和时间
   - 测试无效的日期和时间格式

3. **错误处理测试**：
   - 测试缺少必填参数（标题）的情况
   - 测试提供时间但不提供日期的情况

## 进一步改进

未来可能的改进方向：

1. 支持重复提醒（每天、每周、每月等）
2. 支持设置提醒优先级
3. 支持添加到特定提醒事项列表
4. 支持设置位置提醒
5. 支持查询和修改现有提醒事项
