Skip to main content
Glama

update_enrollments

Update existing enrollments in batch to activate or deactivate learner access, and set or clear due and expiration dates.

Instructions

Change access on existing enrolments. This is a BATCH operation.

    Pass `enrollments`, a list of items each needing an `id`. Writable fields:

      active       true reactivates, false deactivates. NULL IS INVALID - omit the
                   field entirely to leave it unchanged.
      due_at       a timestamp, or null to CLEAR it
      expires_at   a timestamp, or null to CLEAR it

    Note the asymmetry: null clears `due_at` and `expires_at` but is rejected for
    `active`. Deactivating removes a learner's access to the course.

    Requires the `enrollments:write` OAuth scope.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
enrollmentsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsYes
noteYes
totalYes
failedYes
succeededYes
Install Server

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, the description discloses important behavior: null clears due_at and expires_at but is rejected for active, omitting active leaves it unchanged, and deactivating removes a learner's access. It also states the required OAuth scope. No contradiction with annotations.

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

Conciseness5/5

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

The description is well-structured with a short purpose, a bulleted set of fields, a highlighted asymmetry note, and a final scope requirement. Every sentence adds information; nothing is filler.

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

Completeness4/5

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

The description covers purpose, batch semantics, field-level rules, side effects, and auth requirements; an output schema exists so return values need no explanation. It stops short of describing failure/partial-failure behavior or how unknown fields in the item objects are handled, which would be useful for a batch mutation tool.

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

Parameters5/5

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

With 0% schema description coverage, the description carries the full burden for the enrollments array and does so thoroughly: each item needs an id, the writable fields are listed, and the null semantics for each field are specified. This is far more actionable than the bare schema.

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?

The description opens with a specific verb and resource: 'Change access on existing enrolments', and identifies it as a BATCH operation. It then enumerates the writable fields, making it easy to distinguish from sibling tools like list_enrollments, get_enrollment, complete_enrollments, and bulk_enroll_students.

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

Usage Guidelines4/5

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

It clearly frames this as operating on existing enrollments in batch, and the required OAuth scope is stated. It does not explicitly name alternatives or state when not to use it, but the context is sufficient to route an agent to this tool for updating active/due_at/expires_at.

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

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CloudSecurityAlliance/csa-skilljar'

If you have feedback or need assistance with the MCP directory API, please join our Discord server