Built LMS Help Center
MCP ServerTool Reference

Cancel Live Session

Cancel Live Session MCP tool.

Cancel Live Session

Cancel one live session and notify enrolled learners. Completed sessions cannot be cancelled; re-cancelling is a no-op.

Contract

FieldValue
Tool namecancel_live_session
Domainlive_learning
Required scopescourses:write
TitleCancel live session
Read only hintfalse
Destructive hinttrue
Idempotent hinttrue
Open world hintfalse
Bulk limitnone
Timeout10000ms
Kill switch keylive_learning.sessions.cancel
REST siblingDELETE /api/public/v1/live-learning/sessions/{id}

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)$"
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9._:-]+$"
    }
  },
  "required": [
    "id",
    "idempotency_key"
  ],
  "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