Skip to main content
Glama

Enroll User

enroll_user
Destructive

Enroll a user in a Canvas course by providing course ID, user ID, and role (student, teacher, TA, observer, designer). Optionally set enrollment state to active, invited, or inactive.

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)
Behavior2/5

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

Annotations already flag destructiveHint: true, but the description adds no context about potential side effects (e.g., overriding existing enrollments, changing user access). The description only states the basic action, leaving the agent without behavioral insights beyond the annotation.

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 a single sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and efficient.

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

Completeness3/5

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

The tool has four parameters and no output schema, and the description is minimal. It does not mention default behavior like enrollment_state defaulting to 'invited', potential conflicts with existing enrollments, or the meaning of the destructiveHint annotation. Adequate for a simple operation but with clear gaps.

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%, with all parameters described in the input schema. The description's mention of 'specified role' reinforces the `type` parameter but adds no additional meaning beyond what the schema already provides, so baseline 3 is appropriate.

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 'Enroll a user in a course with a specified role' clearly identifies the action (enroll), the resource (user in course), and the key parameter (role). It distinguishes this from sibling tools like remove_enrollment and list_enrollments.

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 its usage by stating the output action, but it does not explicitly say when to use it versus alternatives like remove_enrollment or list_course_enrollments. No exclusions or prerequisites are mentioned.

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

Install Server

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/bruchris/canvas-lms-mcp'

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