使用说明
项目简介
本项目 'calendar-mcp' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为AI助手(如 Claude Desktop)提供与 Google 日历集成的能力。通过此服务器,用户可以使用自然语言指令,让AI助手管理其Google日历,例如创建、更新、删除、查询日程等。
主要功能点
- 日历事件管理:支持创建、更新、删除和检索Google日历事件。
- 自然语言日期时间:支持使用自然语言描述日期和时间,例如“明天下午2点”、“下周一”等。
- 事件列表和搜索:可以列出指定时间范围内的事件,并支持关键词搜索。
- OAuth2 自动认证:简化Google日历API的OAuth2认证流程,支持自动浏览器启动进行认证。
- 全局凭据存储:认证凭据全局存储,方便在任何目录使用。
安装步骤
-
创建 Google Cloud 项目并获取凭据:
- 访问 Google Cloud Console,创建一个新的Google Cloud项目或选择现有项目。
- 为您的项目启用 Google Calendar API。
- 在 "API 和服务" -> "凭据" 中,点击 "创建凭据" -> "OAuth 客户端 ID"。
- 选择 "桌面应用" 或 "Web 应用程序" 作为应用程序类型,并设置名称。
- 如果选择 "Web 应用程序",请将 'http://localhost:3000/oauth2callback' 添加到 "已授权的重定向 URI" 中。
- 下载 JSON 格式的客户端 OAuth 密钥文件,并将其重命名为 'gcp-oauth.keys.json'。
-
运行认证:
- 全局认证 (推荐):
- 将 'gcp-oauth.keys.json' 文件放置到用户 home 目录下的 '.calendar-mcp' 文件夹中(如果文件夹不存在则创建)。
mkdir -p ~/.calendar-mcp mv gcp-oauth.keys.json ~/.calendar-mcp/- 在终端中运行认证命令:
npx @nchufa/calendar auth - 本地认证:
- 将 'gcp-oauth.keys.json' 文件放置到当前工作目录。
- 在终端中运行认证命令:
npx @nchufa/calendar auth- 认证过程会自动打开浏览器进行Google账户授权,成功后凭据将保存到 '~/.calendar-mcp/credentials.json'。
- 全局认证 (推荐):
-
Claude Desktop 配置:
- 打开 Claude Desktop 的配置文件,通常为 JSON 格式。
- 在 'mcpServers' 字段下添加 'calendar' 服务器配置:
{ "mcpServers": { "calendar": { "command": "npx", "args": [ "@nchufa/calendar" ] } } }- 'command': 指定启动 MCP 服务器的命令,这里使用 'npx' 来运行 '@nchufa/calendar' 包。
- 'args': 传递给启动命令的参数,这里为空数组,因为 '@nchufa/calendar' 包默认启动服务器。
基本使用方法
- 确保已完成安装和认证步骤。
- 启动 Claude Desktop 或其他兼容 MCP 协议的客户端。
- 在客户端中配置并连接到 'calendar' MCP 服务器。
- 使用自然语言指令,通过客户端与 Google 日历进行交互,例如:
- "创建一个明天下午3点的会议,主题是项目讨论"
- "查询下周的日程安排"
- "将今天下午2点的会议推迟到明天"
客户端会将这些自然语言指令转换为对 'calendar' MCP 服务器的工具调用,服务器会处理请求并返回结果。
信息
分类
生产力应用