Skip to main content
Glama

Get Course Structure

get_course_structure
Read-only

Retrieve the complete module and item hierarchy for a course in a single API call, including summary statistics to avoid multiple round-trips.

Instructions

Return the full module → items tree for a course in a single call, with summary stats. Avoids N+1 round-trips when an agent needs to reason over the whole course shape.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesThe Canvas course ID
include_published_onlyNoWhen true, exclude unpublished items from each module (default: false)
include_content_detailsNoWhen true, fetch content_details for each item (adds extra Canvas API data; default: false)

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

A4.2/5.0
Behavior4/5

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

Annotations already mark this as read-only, and the description adds useful behavioral context: it returns the complete tree in one call, includes summary stats, and is explicitly designed to avoid N+1 round-trips. It does not detail pagination, payload size, or return field specifics, but the behavior is meaningfully disclosed.

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 efficient sentences with no filler. The core behavior is front-loaded in the first sentence, and the second sentence adds practical guidance about when the tool is valuable. Every sentence earns its place.

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 read-only aggregation tool, the description provides enough information to understand the output shape and purpose: a one-call module tree with summary stats. The lack of an output schema and the absence of explicit sibling exclusions leave some room for ambiguity, but overall the context is solid.

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?

All three parameters are fully described in the schema (100% coverage), so the schema carries the parameter documentation burden. The tool description adds no parameter-level detail beyond what the schema already provides, so the baseline score of 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 states a specific verb and resource: 'Return the full module → items tree for a course in a single call, with summary stats.' This clearly separates it from finer-grained siblings like list_modules or list_module_items by emphasizing the full tree and single-call scope.

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?

It gives a clear usage condition: use this when the agent needs to reason over the whole course shape, and explains why it is preferable ('Avoids N+1 round-trips'). It does not name alternatives or state when NOT to use it, so it stops short of a 5.

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