Workalizer MCP Tools Reference
This reference describes every tool exposed by the Workalizer MCP server. All analytics tools are read-only, use the same data path as the Workalizer web app, and return current period vs previous period comparisons where applicable.
Shared Parameters (Analytics Tools)
These four tools accept the same input schema:
period—week,month,3month,6month,year, orcustom(presets match the Workalizer web app)customDateFrom—YYYY-MM-DD, required whenperiodiscustomcustomDateTo—YYYY-MM-DD, required whenperiodiscustomorgUnitId— optional integer to filter results to a specific organizational unit
Chart grouping (day, week, or month) is computed automatically from the date range.
Example: preset period
{ "period": "month" }Example: custom range
{
"period": "custom",
"customDateFrom": "2026-06-01",
"customDateTo": "2026-06-14"
}health_check
Input: None.
Returns: ok — confirms the MCP server is running.
Use when: Verifying connectivity before troubleshooting OAuth or analytics queries.
get_current_user
Input: None.
Returns: Authenticated user summary — id, email, name, role, workspaceId, workspaceStatus.
Use when: Confirming who is signed in or which workspace context is active.
time_spent_on_work_activities
Returns: Estimated time spent across Gmail, Drive, Chat, Meet, and Calendar for the workspace or org unit. Includes current vs previous period comparison, grouped by day, week, or month.
Use when: Understanding how time is distributed across Workspace apps — e.g. “How did the team spend time on work activities last quarter?”
get_communication_summary
Returns: Initiated and received communication metrics across:
- Email — sent and received
- Chat — messages posted, reactions, messages received
- Docs — comments added and received
- Meetings — organized and participated
Current vs previous period for each channel.
Use when: Reviewing collaboration volume and balance — e.g. “Show team communication summary for the last month.”
get_meetings_summary
Returns:
- Total meeting duration (seconds)
- Daily average duration per user
- Recurring meetings duration
- Scheduled meetings participation rate
Current vs previous period.
Use when: Analyzing meeting load — e.g. “How much time did the engineering org spend in meetings this month compared to last month?”
get_drive_activity_summary
Returns: Documents created and updated over time. Current vs previous period.
Use when: Tracking document output and collaboration — e.g. “How active was the team on Drive last month?”
Access and Permissions
If a tool returns an access error, your Workalizer user may lack workspace analytics permissions or the workspace may be inactive. MCP enforces the same access rules as the web app — it cannot return data outside your authorized scope.
