Skip to main content
Glama

list_students

Retrieve students enrolled in a Canvas course with enrollment details like section, activity, and last login. Filter by enrollment state or section to get targeted student lists.

Instructions

List students enrolled in a course with enrollment-specific data (section, activity, last login). For a simpler user list with any role (teachers, TAs, etc.), use list_users_in_course instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
stateNoFilter by enrollment state(s)
course_idYesCanvas course ID
section_idNoFilter to a specific section
Behavior4/5

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

With no annotations provided, the description carries the burden of disclosing behavior. It clarifies that this lists only students (not all roles) and includes specific enrollment data like section, activity, and last login. However, it does not mention pagination or any side effects, but for a read-only list tool this is a reasonable coverage level.

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?

Two concise sentences: the first states the primary purpose and data scope, the second offers a clear alternative. No wasted words or redundant information.

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?

For a simple list tool, the description is mostly complete. It explains the tool's purpose, what data is included, and when to use an alternative. It doesn't elaborate on filter semantics (already in schema) or return format (no output schema), but the description provides enough context for correct selection and invocation.

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% (all three parameters have descriptions), so the baseline is 3. The description adds no parameter-specific detail beyond what the schema already documents, so no additional value is provided.

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 uses a specific verb 'List' and clearly identifies the resource as 'students enrolled in a course' with a defined scope ('enrollment-specific data'). It explicitly distinguishes itself from the sibling tool by contrasting with 'list_users_in_course'.

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

Usage Guidelines5/5

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

Directly states the alternative use case: 'For a simpler user list with any role (teachers, TAs, etc.), use list_users_in_course instead.' This gives clear when-to-use and when-not-to-use guidance, citing the sibling tool.

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/hughsibbele/Canvas-Agent'

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