Skip to main content
Glama

course_enrollments_update

Destructive

Give a learner access to a course by email, or revoke or restore an enrollment.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace": "<workspace>",
      "action": "<action>"
    },
    "name": "course_enrollments_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
emailNo
actionYes
course_idNo
workspaceYes
enrollment_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. The description adds no behavioral context beyond that: nothing about whether revoke deletes records or only flags them, whether notifications go to the learner, whether restore requires a prior revoke, or whether operations are idempotent. For a destructive mutation tool, this leaves a real gap.

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?

A single, front-loaded sentence with the primary operation first and the two alternative operations trailing. Nothing is wasted, though the compactness comes at the cost of the missing requiredness and prerequisite detail.

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

Completeness2/5

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

With five parameters, only two required, 0% schema description coverage, no output schema, and a destructive annotation, the description should do more: it should map parameters to actions, explain the required workspace, and describe the effect of revoke versus restore. As written, an agent would still have to guess at invocation details.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must carry parameter meaning. It partially does, implicitly linking email to grant and enrollment to revoke/restore and mentioning the course, but it never mentions the required 'workspace' parameter or clarifies which parameters are required for which action (e.g., email+course_id for grant vs enrollment_id for revoke/restore).

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

Purpose4/5

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

The description states a specific verb and resource ('Give a learner access to a course') and enumerates the three operations: grant, revoke, restore. That is clear enough to identify the tool without opening the schema, though it doesn't explicitly name the action parameter or differentiate it from any near-analogous tool.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: 'by email' hints that grant keys off email, and 'revoke or restore an enrollment' hints that those actions key off an enrollment. There is no explicit when-to-use-which-action guidance, no prerequisites, and no note on what happens if you revoke an enrollment that does not exist.

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