Skip to main content
Glama

Enroll User

enroll_user
Destructive

Enroll a user in a Canvas course by specifying course ID, user ID, and enrollment type like Teacher or Student.

Instructions

Enroll a user in a course with a specified role.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeYesThe enrollment type
user_idYesThe Canvas user ID to enroll
course_idYesThe Canvas course ID
enrollment_stateNoInitial enrollment state (defaults to invited)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.18.11
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv1.18.0

TDQS

B3.1/5.0
Behavior2/5

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

The annotations include destructiveHint=true, which signals mutation, but the description does not disclose behavioral traits beyond that. It doesn't mention that enrollment may send invitations, that changing enrollment_state affects user access, that re-enrolling an existing user may update their enrollment, or that this operation may be irreversible. With destructiveHint=true, the description carries a burden to explain consequences, and it fails to do so.

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?

The description is a single, efficient sentence that front-loads the core action and key parameter. It earns its place with no filler, though it could add a brief note about enrollment_state behavior without becoming verbose.

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?

For a mutation tool with destructiveHint=true and no output schema, the description is thin. It doesn't explain what happens after enrollment (e.g., invitation workflow, default state), what the response contains, or any side effects. An agent would need to infer too much about the operation's consequences.

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 100%, so the schema already documents all four parameters. The description adds the phrase 'with a specified role', which maps to the 'type' parameter, but it doesn't add meaning beyond the schema's own descriptions. Baseline 3 is appropriate because the schema does the heavy lifting.

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 ('Enroll'), a resource ('a user in a course'), and a key parameter ('with a specified role'). It clearly distinguishes the tool from siblings like list_enrollments and remove_enrollment, though it doesn't explicitly name them.

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?

The description implies the primary use case: adding a user to a course with a role. It doesn't explicitly state when to use this tool versus alternatives like list_course_enrollments or remove_enrollment, nor does it mention prerequisites (e.g., the user must exist, the course must be active). The context is clear but exclusions and alternatives are not stated.

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

Deploy Server

Other Tools