Skip to main content
Glama

Cubite LMS: Learning Management System

Update enrollment

enrollment_update
Destructive

Change one existing enrollment in place, keeping it and the learner's progress: set or clear its access expiry, move the learner off or onto the waitlist, or relabel its status. Use it for every change to an enrollment that exists; to add one use enrollment_create, to remove one enrollment_revoke. Identify the learner by email or userId; a learner not enrolled in that course is a not-found error, and omitted fields stay unchanged. To let a waitlisted learner in, send isWaitListed:false with status:"completed": self-waitlisted learners hold "pending", and learner pages show Start/Continue only for "completed". No email is sent. Returns the updated enrollment {courseId, userId, status, isWaitListed, enrolledAt, expiresAt, user}.

Input Schema

NameRequiredDescriptionDefault
emailNoLearner's email; pass this or userId.
statusNoFree-text status label, stored as given (trimmed, cut to 64 chars); Cubite itself writes "completed", "pending" or, for learning-path enrollments, "active". Learner pages give the Start/Continue button only to "completed" (on a paid course, only once the learner has paid); with any other label the dashboard card and the course page show an enrollment step instead ("Start Now", "Complete Enrollment" or checkout). Omit it to keep the current label.
userIdNoLearner's user id; pass this or email (userId wins if both are sent).
courseIdYesCourse id (required). For a course linked to Open edX this changes only the Cubite enrollment; to also enroll a waitlisted learner in Open edX, use the dashboard's Unlock button.
expiresAtNoNew access expiry as an ISO 8601 date string (e.g. "2026-12-31"); null removes the expiry (never expires); omit to leave it unchanged.
isWaitListedNofalse promotes the learner off the waitlist; true moves them back onto it. Either way the status label stays as it is unless you also send status.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare destructiveHint=true and readOnlyHint=false, and the description adds context the annotations cannot: mutations are in place and preserve learner progress, omitted fields stay unchanged, a non-enrolled learner yields a not-found error, and no email is sent. It also discloses the return payload shape, which is significant given there is no output schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose, then alternatives, then semantics, with no filler sentences. It is dense and long for a single tool, but each clause (waitlist mechanics, no-email behavior, return shape) carries information an agent needs, so the length is largely earned.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description compensates by listing the returned enrollment fields (courseId, userId, status, isWaitListed, enrolledAt, expiresAt, user). Combined with annotation-covered safety and explicit error behavior, nothing needed to invoke this mutation correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real value beyond the schema: it explains that identity is email or userId, that omitted fields are unchanged, and the non-obvious interaction of isWaitListed:false with status:"completed" to surface Start/Continue. It stops short of documenting any edge semantics the schema already owns.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Change one existing enrollment in place') and enumerates the three mutable aspects: access expiry, waitlist membership, and status label. It directly distinguishes itself from enrollment_create and enrollment_revoke by naming both siblings, so an agent can select it without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit routing: 'Use it for every change to an enrollment that exists; to add one use enrollment_create, to remove one enrollment_revoke.' It also names the waitlist-promotion idiom (isWaitListed:false with status:"completed") and the prerequisite that the learner must be enrolled, covering when-not (not-found error) and alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources