diff --git a/docs.json b/docs.json index b64e6c4..6da9715 100644 --- a/docs.json +++ b/docs.json @@ -143,6 +143,23 @@ } ], "root": "projects/cli-factory/providers/example/index" + }, + { + "group": "Google Workspace", + "pages": [ + "projects/cli-factory/providers/google-workspace/index", + { + "expanded": true, + "group": "Tools", + "pages": [ + "projects/cli-factory/providers/google-workspace/tools/calendar-check", + "projects/cli-factory/providers/google-workspace/tools/calendar-create", + "projects/cli-factory/providers/google-workspace/tools/gmail-check", + "projects/cli-factory/providers/google-workspace/tools/gmail-send" + ] + } + ], + "root": "projects/cli-factory/providers/google-workspace/index" } ], "root": "projects/cli-factory/providers/overview" diff --git a/projects/cli-factory/providers/google-workspace/index.mdx b/projects/cli-factory/providers/google-workspace/index.mdx new file mode 100644 index 0000000..382a9bb --- /dev/null +++ b/projects/cli-factory/providers/google-workspace/index.mdx @@ -0,0 +1,34 @@ +--- +title: Google Workspace +description: Use Gmail and Google Calendar from a Google Workspace account. +sidebarTitle: Google Workspace +--- + + + +# Google Workspace + +Google Workspace exposes curated Gmail and Google Calendar workflows for agents: +send and check email, and create and check calendar events with OAuth-backed API access. + +## Categories + +email, calendar, productivity + +## Aliases + +google, gmail, calendar + +## Provider Parameters + +- `access_token`: Google OAuth 2.0 access token with Gmail and Calendar scopes. +- `user_id`: Gmail user identifier. Defaults to me. +- `calendar_id`: Google Calendar ID. Defaults to primary. + +## Tools + +- [Calendar Check](./tools/calendar-check): Search Google Calendar events. +- [Calendar Create](./tools/calendar-create): Create a Google Calendar event. +- [Gmail Check](./tools/gmail-check): Search recent Gmail messages. +- [Gmail Send](./tools/gmail-send): Send a Gmail message from a Google Workspace account. + diff --git a/projects/cli-factory/providers/google-workspace/tools/calendar-check.mdx b/projects/cli-factory/providers/google-workspace/tools/calendar-check.mdx new file mode 100644 index 0000000..a69f313 --- /dev/null +++ b/projects/cli-factory/providers/google-workspace/tools/calendar-check.mdx @@ -0,0 +1,95 @@ +--- +title: Calendar Check +description: Search Google Calendar events. +sidebarTitle: Calendar Check +--- + + + +# Calendar Check + +**Provider:** [Google Workspace](../index) + +List or search Google Calendar events in a time window on the configured +calendar. + +## Command Path + +google-workspace, calendar-check + +## Categories + +calendar, scheduling, search + +## Aliases + +check-events, list-events + +## Provider Parameters + +access_token, user_id, calendar_id + +## Input Parameters + +max_results, query, single_events, time_max, time_min + +## Output Fields + +events, next_page_token, result_count + +## Input Schema + +```yaml +type: object +required: + - time_min + - time_max +properties: + time_min: + type: string + format: date-time + time_max: + type: string + format: date-time + query: + type: string + max_results: + type: integer + minimum: 1 + maximum: 50 + default: 10 + single_events: + type: boolean + default: true +``` + +## Output Schema + +```yaml +type: object +properties: + result_count: + type: integer + next_page_token: + type: string + events: + type: array + items: + type: object + properties: + event_id: + type: string + summary: + type: string + status: + type: string + html_link: + type: string + start: + type: string + end: + type: string + location: + type: string +``` + diff --git a/projects/cli-factory/providers/google-workspace/tools/calendar-create.mdx b/projects/cli-factory/providers/google-workspace/tools/calendar-create.mdx new file mode 100644 index 0000000..de20dda --- /dev/null +++ b/projects/cli-factory/providers/google-workspace/tools/calendar-create.mdx @@ -0,0 +1,107 @@ +--- +title: Calendar Create +description: Create a Google Calendar event. +sidebarTitle: Calendar Create +--- + + + +# Calendar Create + +**Provider:** [Google Workspace](../index) + +Create a Google Calendar event on the configured calendar and return compact +event details. + +## Command Path + +google-workspace, calendar-create + +## Categories + +calendar, scheduling + +## Aliases + +create-event, schedule + +## Provider Parameters + +access_token, user_id, calendar_id + +## Input Parameters + +attendees, description, end, location, start, summary, time_zone + +## Output Fields + +attendees, end, event_id, html_link, start, status, summary + +## Input Schema + +```yaml +type: object +required: + - summary + - start + - end +properties: + summary: + type: string + minLength: 1 + start: + type: string + format: date-time + description: RFC3339 start timestamp. + end: + type: string + format: date-time + description: RFC3339 end timestamp. + time_zone: + type: string + description: Optional IANA time zone. + description: + type: string + location: + type: string + attendees: + type: array + items: + type: object + required: + - email + properties: + email: + type: string + display_name: + type: string +``` + +## Output Schema + +```yaml +type: object +properties: + event_id: + type: string + html_link: + type: string + status: + type: string + summary: + type: string + start: + type: string + end: + type: string + attendees: + type: array + items: + type: object + properties: + email: + type: string + response_status: + type: string +``` + diff --git a/projects/cli-factory/providers/google-workspace/tools/gmail-check.mdx b/projects/cli-factory/providers/google-workspace/tools/gmail-check.mdx new file mode 100644 index 0000000..b908911 --- /dev/null +++ b/projects/cli-factory/providers/google-workspace/tools/gmail-check.mdx @@ -0,0 +1,81 @@ +--- +title: Gmail Check +description: Search recent Gmail messages. +sidebarTitle: Gmail Check +--- + + + +# Gmail Check + +**Provider:** [Google Workspace](../index) + +Search or list Gmail messages for the authenticated Google Workspace user and +return compact message details. + +## Command Path + +google-workspace, gmail-check + +## Categories + +email, gmail, search + +## Aliases + +check-email, search-email + +## Provider Parameters + +access_token, user_id, calendar_id + +## Input Parameters + +include_snippet, max_results, query + +## Output Fields + +messages, result_count + +## Input Schema + +```yaml +type: object +properties: + query: + type: string + description: Gmail search query. + max_results: + type: integer + minimum: 1 + maximum: 25 + default: 10 + include_snippet: + type: boolean + default: true +``` + +## Output Schema + +```yaml +type: object +properties: + result_count: + type: integer + messages: + type: array + items: + type: object + properties: + id: + type: string + thread_id: + type: string + snippet: + type: string + label_ids: + type: array + items: + type: string +``` + diff --git a/projects/cli-factory/providers/google-workspace/tools/gmail-send.mdx b/projects/cli-factory/providers/google-workspace/tools/gmail-send.mdx new file mode 100644 index 0000000..a4edfe5 --- /dev/null +++ b/projects/cli-factory/providers/google-workspace/tools/gmail-send.mdx @@ -0,0 +1,87 @@ +--- +title: Gmail Send +description: Send a Gmail message from a Google Workspace account. +sidebarTitle: Gmail Send +--- + + + +# Gmail Send + +**Provider:** [Google Workspace](../index) + +Send a plain-text Gmail message through the Gmail API using OAuth-backed +Google Workspace credentials. + +## Command Path + +google-workspace, gmail-send + +## Categories + +email, gmail + +## Aliases + +send-email, email + +## Provider Parameters + +access_token, user_id, calendar_id + +## Input Parameters + +bcc, body_text, cc, subject, to + +## Output Fields + +label_ids, message_id, thread_id + +## Input Schema + +```yaml +type: object +required: + - to + - subject + - body_text +properties: + to: + type: array + items: + type: string + minItems: 1 + description: Recipient email addresses. + cc: + type: array + items: + type: string + description: Optional CC recipients. + bcc: + type: array + items: + type: string + description: Optional BCC recipients. + subject: + type: string + minLength: 1 + body_text: + type: string + minLength: 1 +``` + +## Output Schema + +```yaml +type: object +properties: + message_id: + type: string + thread_id: + type: string + label_ids: + type: array + items: + type: string +``` + diff --git a/projects/cli-factory/providers/overview.mdx b/projects/cli-factory/providers/overview.mdx index bddcc6d..03a6c84 100644 --- a/projects/cli-factory/providers/overview.mdx +++ b/projects/cli-factory/providers/overview.mdx @@ -9,4 +9,5 @@ sidebarTitle: Providers # Providers - [Example](./example): Example provider for validating CLI Factory behavior. +- [Google Workspace](./google-workspace): Use Gmail and Google Calendar from a Google Workspace account.