README
🚀 Apple 提醒 MCP 服务器
一个提供与 macOS 上的 Apple Reminders 原生集成的 MCP 服务器。借助该服务器,用户能通过标准化接口与提醒事项进行交互操作,提升任务管理效率。
English | 简体中文
🚀 快速开始
此 MCP 服务器可与 macOS 上的 Apple Reminders 实现原生集成,用户能通过标准化接口对提醒事项进行交互操作。
✨ 主要特性
- 列出所有提醒和提醒列表:用户可查看所有提醒事项及其所属的提醒列表。
- 创建新提醒:支持添加新提醒事项,可自定义标题、所属列表、完成状态、截止日期及备注信息。
- 标记提醒为完成或未完成:允许用户更新特定提醒的完成状态。
- 添加备注:能在提醒事项中添加额外信息备注,详细记录任务细节。
- 设置截止日期:为每个提醒事项设定具体截止时间,助力用户管理任务优先级。
- macOS 原生集成:通过 Swift 实现本地集成,确保与 Apple 提醒服务高度兼容且性能优化。
📦 安装指南
先决条件
- 操作系统要求:macOS 系统(因项目依赖 Apple 提醒服务)。
- Node.js 版本要求:Node.js 18 或更高版本,以支持最新特性及保障安全性。
- 开发工具要求:Xcode 命令行工具,用于 Swift 代码的编译与构建。
安装命令
npm install -g mcp-server-apple-reminders
📚 详细文档
配置指南
在 Cursor 中配置
- 打开 Cursor 的设置界面。
- 导航至插件管理部分。
- 添加新的 MCP 服务器配置,指定服务器地址及端口。
- 启用 Apple 提醒集成选项。
在 ChatWise 中配置
- 进入 ChatWise 的偏好设置菜单。
- 选择插件与扩展选项卡。
- 添加一个新的 MCP 服务条目,填写相应的服务器信息。
- 启动 Apple 提醒同步功能。
在 Claude Desktop 中配置
方法一:直接编辑配置文件
- 打开终端应用。
- 输入以下命令访问用户目录下的配置文件:
cd ~/Library/Application\ Support/Claude/ - 编辑
config.json文件,添加以下内容:"mcpServers": { "appleRemindersServer": { "url": "http://localhost:8080", "enabled": true } }
方法二:通过图形界面配置
- 打开 Claude Desktop 的设置窗口。
- 选择插件管理标签。
- 点击“添加新服务器”按钮,输入 Apple 提醒 MCP 服务器的相关信息。
- 完成后保存设置。
开发步骤
-
安装依赖项:
npm install -
构建 Swift 执行文件(用于 Apple 提醒本地集成):
npm run build:swift -
编译 TypeScript 代码:
npm run build:ts -
启动开发服务器:
npm run start
项目结构
.
├── src/ # 源代码目录
│ ├── index.ts # 应用程序的主入口点
│ ├── server/ # MCP 服务器实现部分
│ ├── swift/ # 原生 Swift 集成代码
│ │ ├── bin/ # 编译后的 Swift 可执行文件
│ │ └── src/ # Swift 源代码文件
│ ├── tools/ # CLI 工具与辅助脚本
│ ├── types/ # TypeScript 类型定义
│ └── utils/ # 辅助函数和工具模块
├── dist/ # 编译后的输出目录(用于生产环境)
└── package.json # 项目依赖管理文件
💻 使用示例
基础用法
创建提醒
# 示例:创建一个新的购物提醒事项
{
"command": "create_reminder",
"title": "购买杂货",
"list": "家庭",
"duedate": "2024-03-25T18:00:00Z",
"notes": "不要忘记买牛奶"
}
查询提醒
# 示例:列出指定列表中的未完成提醒
{
"command": "list_reminders",
"filter": {
"list": "工作",
"showCompleted": false
}
}
更新提醒状态
# 示例:将特定提醒标记为已完成
{
"command": "update_reminder_status",
"reminderId": 123,
"completed": true
}
⚠️ 注意事项
⚠️ 重要提示
- 在 macOS 系统中,确保应用程序有权限访问 Apple 提醒服务,可能需在系统偏好设置中进行授权。
- 建议在不同的 macOS 版本上进行测试,以验证插件的兼容性。
- 由于直接操作本地提醒数据库,可能会遇到与其他客户端(如 iCloud)数据不同步的问题,请确保定期手动同步。
🤝 贡献指南
欢迎贡献代码或提出问题与建议。请参考项目仓库中的 CONTRIBUTING.md 文件了解具体的协作流程和规范。
📄 许可证
本项目遵循 MIT 许可证协议,具体内容可见项目的 LICENSE 文件。
通过以上步骤和配置,您能够顺利地在 macOS 系统中实现 Apple 提醒服务与 MCP 服务器的集成,从而增强任务管理的效率。
Scan to contact