Skip to main content
Glama

List Topics

list_topics
Read-onlyIdempotent

List discussion topics in a Canvas course with unread counts and post-before-viewing requirements, so you can identify what needs attention; optionally filter announcements or search titles.

Instructions

List discussion topics in a course with unread counts and whether you must post before seeing replies. Read-only. Set only_announcements for announcements; read a thread with get_full_topic_view.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>"
    },
    "name": "list_topics"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoWhich page of results to show, starting at 1. Use it when a result says there are more.
limitNoMaximum number of items to return (one page of results). Smaller is faster.
course_idYesCanvas course ID, a numeric string such as "12345". Get it from list_courses.
search_termNoOptional text filter on names or titles (at least 2 characters, case-insensitive).
only_announcementsNoIf true, return announcements instead of discussion topics.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.0
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of items to return. Smaller is faster."New value: +"Maximum number of items to return (one page of results). Smaller is faster."
    • addedInput schema / properties / page
      Added value: +{
      +  "description": "Which page of results to show, starting at 1. Use it when a result says there are more.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
  2. Changed4 schema fields changedv1.0.2
    • changedInput schema / properties / course_id / description
      Previous value: -"Canvas course ID"New value: +"Canvas course ID, a numeric string such as \"12345\". Get it from list_courses."
    • changedInput schema / properties / limit / description
      Previous value: -"Max items to return"New value: +"Maximum number of items to return. Smaller is faster."
    • addedInput schema / properties / only_announcements / description
      Added value: +"If true, return announcements instead of discussion topics."
    • addedInput schema / properties / search_term / description
      Added value: +"Optional text filter on names or titles (at least 2 characters, case-insensitive)."
  3. First observedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the redundant 'Read-only' sentence adds nothing. However, the description does disclose what each row carries (unread counts and the must-post requirement), which is behavioral context absent from the annotations.

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?

Three short sentences, front-loaded with purpose, then the flag behavior, then the sibling handoff. No filler and nothing that could be trimmed without losing routing 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?

With no output schema, the description usefully names the returned fields, and all five parameters are documented in-schema. Minor omission: pagination behavior (page/limit interplay) is left entirely to the schema even though this is a list endpoint likely to be paged.

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%, documenting course_id, page, limit, search_term and only_announcements in detail, so the baseline is 3. The description only restates the announcements switch and adds no format or filtering nuance beyond the schema.

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?

States a specific verb and resource ('List discussion topics in a course') and immediately adds the distinguishing payload (unread counts, must-post-before-replies flag). It also names the thread-reading sibling get_full_topic_view, so an agent can separate listing from viewing without opening schemas.

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?

Gives two concrete routing rules: use only_announcements for announcements, and use get_full_topic_view to read a thread. It does not address when to prefer list_announcements or list_entries over this tool, so the guidance is clear but not exhaustive.

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