返回 MCP 目录
public公开dns本地运行

cal2prompt

cal2prompt是一个命令行工具,可将Google日历日程转换为自定义提示或文本片段,支持模板引擎和MCP服务器模式。

article

README

🚀 cal2prompt项目

cal2prompt项目用于对日历数据进行配置和处理,通过配置文件和环境变量的设置,可以从Google日历获取事件并进行格式化输出,同时还支持一些实验性功能。

⚠️ 注意事项

⚠️ 重要提示

请仔细阅读并遵循所有说明和安全指南,以避免潜在的风险或错误。

📦 安装指南

1. 配置文件准备

创建一个 Lua 配置文件(例如 config.lua),并在其中指定以下内容:

return {
    settings = {
        TZ = "Asia/Tokyo", -- 示例时区,根据实际需求修改
    },
    source = {
        google = {
            oauth2 = {
                clientID = "your_client_id",
                clientSecret = "your_client_secret",
                scopes = {"https://www.googleapis.com/auth/calendar.events"},
                redirectURL = "http://127.0.0.1:9004"
            },
            calendar = {
                getEvents = {
                    calendarIDs = {"calendar_id_1", "calendar_id_2"}
                }
            }
        }
    },
    output = {
        template = [[
            // 自定义模板内容
        ]]
    },
    experimental = {
        mcp = {
            insertCalendarEvent = {
                calendarID = "target_calendar_id"
            }
        }
    }
}

2. 环境变量设置

在终端中设置以下环境变量:

export CAL2_PROMPT_CONFIG_FILE_PATH=~/.config/cal2prompt/config.lua

📚 详细文档

配置选项

| 属性 | 详情 | |------|------| | settings.TZ | 是必填项,需为 IANA 时区格式(例如 America/Los_AngelesAsia/Tokyo),默认值为 UTC。 | | settings.oauthFilePath | 非必填项,是 OAuth2.0 令牌的临时存储路径。通常无需更改,除非有特殊需求,默认值为 ~/.local/share/cal2prompt/oauth。 | | source.google.oauth2.clientID | 是必填项,用于 Google Calendar API 身份验证的 OAuth2 客户端 ID,无默认值,必须指定。 | | source.google.oauth2.clientSecret | 是必填项,用于 Google Calendar API 身份验证的 OAuth2 客户端密钥,无默认值,必须指定。 | | source.google.oauth2.scopes | 非必填项,是授予 OAuth2 客户端的范围权限。请参考 Google 文档 获取详细信息,默认值为 [ "https://www.googleapis.com/auth/calendar.events" ]。 | | source.google.oauth2.redirectURL | 非必填项,是 Google 用于回调响应的 URL,默认值为 "http://127.0.0.1:9004"。 | | source.google.calendar.getEvents.calendarIDs | 是必填项,是要从中获取事件的一个或多个 Google 日历 ID 列表。每个 ID 可以在 Google 日历设置中找到。如果指定多个 ID,将按时间顺序从所有日历中获取事件,无默认值,必须指定。 | | output.template | 是必填项,定义如何格式化和输出获取的日历数据的字符串,无默认值,必须指定。 | | experimental.mcp.insertCalendarEvent.calendarID | 非必填项,使用实验性 MCP 功能时,要插入事件的目标 Google 日历 ID,无默认值,按需配置。 |

环境变量

在终端中设置以下环境变量:

export CAL2_PROMPT_CONFIG_FILE_PATH=~/.config/cal2prompt/config.lua

如需进一步帮助或遇到问题,请参考官方文档或联系支持团队。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端