Skip to main content
Glama

get_course_structure

Read-only

Retrieve the full module and item structure for a Canvas course in one call. Optionally include unpublished modules and items.

Instructions

Get the full module and item structure for a course in a single call.

    Args:
        course_identifier: Course code or Canvas ID
        include_unpublished: Include unpublished modules and items (default: True)
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_identifierYes
include_unpublishedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already set readOnlyHint=true, so the description does not need to restate safety. It adds value by clarifying that the call returns the entire structure and explaining parameters. No contradictions.

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, front-loaded sentence stating the main purpose, followed by a clean docstring-style parameter list. Every word earns its place with no redundancy.

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

Completeness5/5

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

Given the output schema exists (though not shown), the description does not need to detail return values. It provides the scope ('full module and item structure') and parameter semantics, making it complete for an agent to understand the tool's function.

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

Parameters5/5

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

With 0% schema description coverage, the description fully compensates by explaining that course_identifier can be a course code or Canvas ID, and include_unpublished controls whether unpublished items are included (default True). This adds essential meaning beyond the schema's type-only definitions.

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 clearly states the tool retrieves the full module and item structure for a course in a single call. This verb+resource combination is specific and distinct from sibling tools like list_modules or list_module_items which require multiple calls.

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 efficient bulk retrieval with 'in a single call,' which helps the agent choose it over multiple calls. However, it does not explicitly state when not to use it or provide direct alternatives.

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

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