MCP ServerTool Reference
Withdraw Enrollment
Withdraw Enrollment MCP tool.
Withdraw Enrollment
Withdraw one course enrollment; the record stays with status withdrawn.
Contract
| Field | Value |
|---|---|
| Tool name | withdraw_enrollment |
| Domain | enrollments |
| Required scopes | enrollments:manage |
| Title | Withdraw enrollment |
| Read only hint | false |
| Destructive hint | true |
| Idempotent hint | true |
| Open world hint | false |
| Bulk limit | none |
| Timeout | 10000ms |
| Kill switch key | enrollments.withdraw |
| REST sibling | DELETE /api/public/v1/course-enrollments/{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
}