Skip to content
Docs menu

Tool reference · Team onboarding

New in 14.6.0

onboarding_progress

Shows onboarding progress and the learning log: your own by default, or another employee's for their department head, company viewers and superadmins.

team server /mcp
Caution. Other people's progress is visible only to that department's head, company viewers and superadmins.

When to use

  • An employee asks how far they are.
  • A department head looks at one person in detail (pass user_id).

Parameters

NameTypeDefaultDescription
team_idrequired string — (pattern ^[a-zA-Z0-9_-]{1,64}$)
user_id string — Omit for your own progress. (pattern ^[a-zA-Z0-9_-]{1,64}$)

Example

Arguments

{
  "team_id": "eng"
}

Result shape

{
  "team_id": "eng",
  "user_id": "dina",
  "title": "Engineering onboarding",
  "enrolled_at": "2026-09-25T09:12:04.118Z",
  "modules": [
    {
      "module_id": "mod_deploy",
      "title": "Deploy",
      "status": "passed",
      "lessons_completed": 2,
      "lessons_total": 2
    }
  ],
  "summary": {
    "lessons_completed": 2,
    "lessons_total": 4,
    "modules_finished": 1,
    "modules_total": 2,
    "percent": 50,
    "updated_lessons": 0
  },
  "next": {
    "action": "lesson",
    "module_id": "mod_deploy",
    "lesson_id": "les_pipeline",
    "title": "Pipeline",
    "hint": "Call onboarding_next to open it."
  },
  "log": [
    {
      "at": "2026-09-25T09:31:40.502Z",
      "event": "lesson_completed",
      "summary": "Dina Developer completed lesson 'Pipeline' (module 'Deploy') on 2026-09-25"
    }
  ]
}

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:

Show onboarding progress: your own by default; another employee's only for their department head, company viewers and superadmins.

Found a mistake? Open an issue on GitHub.

Search