onboarding_overview

When to use

• An employee types /onboard without naming a department.
• You need the team_id before calling onboarding_start.
• A department head or company viewer wants to know which departments they can report on or edit.

Parameters

This tool takes no parameters.

Example

Arguments

{}

Result shape

{
  "user": {
    "user_id": "dina",
    "display_name": "Dina Developer",
    "org_role": "member"
  },
  "teams": [
    {
      "team_id": "eng",
      "name": "Engineering",
      "role": "editor",
      "has_curriculum": true,
      "enrolled_at": "2026-09-25T09:12:04.118Z",
      "title": "Engineering onboarding",
      "summary": {
        "lessons_completed": 2,
        "lessons_total": 4,
        "modules_finished": 1,
        "modules_total": 2,
        "percent": 50,
        "updated_lessons": 0
      }
    }
  ],
  "viewable_teams": [],
  "manageable_teams": []
}

A department without a curriculum has has_curriculum: false and cannot be studied yet.

Values are illustrative; the keys follow the server's handler. MCP clients receive the result as JSON text content.

Server description

The description the server sends to your agent in tools/list, captured from the v14.7.0 source:

List your departments with onboarding status, plus departments whose people you may view or manage. Use it to pick team_id before onboarding_start.

Related tools

• onboarding_start
• onboarding_progress
• onboarding_team_report