Skip to content
Docs menu

Tool reference · Team onboarding

New in 14.6.0

onboarding_start

Enrols you in a department's onboarding (or resumes it) and returns the plan with your progress and the next step.

team server /mcp
Caution. Requires membership in the department; enrolment is logged in the department's learning log.

When to use

  • A new employee asks to be onboarded.
  • An employee comes back to continue their course in a new session.
  • You want to show the whole plan: modules, lessons and quizzes with their status.

Parameters

NameTypeDefaultDescription
team_idrequired string — (pattern ^[a-zA-Z0-9_-]{1,64}$)

Example

Arguments

{
  "team_id": "eng"
}

Result shape

{
  "team_id": "eng",
  "title": "Engineering onboarding",
  "enrolled_at": "2026-09-25T09:12:04.118Z",
  "newly_enrolled": true,
  "plan": [
    {
      "module_id": "mod_deploy",
      "title": "Deploy",
      "status": "in_progress",
      "lessons_completed": 0,
      "lessons_total": 2,
      "lessons": [
        {
          "lesson_id": "les_pipeline",
          "title": "Pipeline",
          "status": "not_started"
        }
      ],
      "quiz": {
        "questions": 4,
        "pass_threshold": 0.8,
        "attempts_left": 3
      }
    }
  ],
  "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."
  }
}

Lessons whose sources changed after you studied them are flagged updated_since_studied.

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:

Start or resume onboarding in a department: enrolls you and returns the plan (modules, lessons, quizzes) with your progress and the next step. Use first when a new employee asks to be onboarded.

Found a mistake? Open an issue on GitHub.

Search