Built LMS Help Center
MCP ServerTool Reference

Get Enrollment Progress

Get Enrollment Progress MCP tool.

Get Enrollment Progress

Progress for one course enrollment: status, progress_percentage (stored, 0-100), completed_modules of total_modules, time_spent_minutes, dates, and modules in course order with status ("not_started" if never opened), completed, progress_percentage, time_spent_seconds. modules is empty if the course has no course-builder modules.

Contract

FieldValue
Tool nameget_enrollment_progress
Domainprogress
Required scopesenrollments:read
TitleGet enrollment progress
Read only hinttrue
Destructive hintfalse
Idempotent hintfalse
Open world hintfalse
Bulk limitnone
Timeout10000ms
Kill switch keyprogress.enrollments.get
REST siblingGET /api/public/v1/course-enrollments/{id}/progress

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "const": "text"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "text"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "content"
  ],
  "additionalProperties": false
}

On this page