Skip to main content
Glama

List Students

list_students
Read-only

Retrieve all students enrolled in a specific Canvas course by providing its course ID, enabling quick access to class rosters for administrative or grading workflows.

Instructions

List all students enrolled in a course.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesThe Canvas course ID
Behavior3/5

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

Annotations already declare readOnlyHint=true, indicating no mutations, so the description's simple phrase adds no further behavioral disclosure. There is no mention of pagination, sorting, or enrollment status filtering, which would be useful for a list operation. No annotation contradiction.

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, short sentence that perfectly captures the tool's purpose with no wasted words. It is front-loaded and concise.

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 tool is a simple list operation with a single parameter and a clear purpose. While the description doesn't explain return values (no output schema exists), the tool's richness is limited, so the given description is reasonably complete for an agent to make an informed selection. A small note about pagination or enumeration could improve, but it is not essential for basic understanding.

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 coverage is 100%, and the only parameter course_id is well-described in the schema as 'The Canvas course ID'. The description adds no additional semantics beyond that, but given the high coverage, baseline 3 is appropriate.

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 ('List') and resource ('all students enrolled in a course'), which is clear and unambiguous. However, it does not explicitly distinguish itself from the nearly identical sibling tool 'list_students_needing_attention' or other student-related listing tools, though the course_id parameter provides some context.

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?

The description implies usage in a course context ('enrolled in a course') and the required course_id parameter makes it clear it is for course-scoped queries. It does not explicitly state when not to use it versus alternatives like 'list_course_users' or 'list_students_needing_attention', but the scope is reasonably obvious.

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