Skip to main content
Glama

canvas_list_discussion_topics

Read-only

Retrieve discussion topics for a course to review announcements and forum posts. Filter by order, announcements-only, and response detail.

Instructions

List discussion topics for a course (read-only).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands. compact removes the avatar URLs Canvas attaches to user objects (avatar_url, avatar_image_url); "full" returns Canvas's payload untouched. Link fields (url, html_url, preview_url) survive both rungs. No field projection: this server passes Canvas's payload through verbatim and has no verified record of which of its fields a caller needs.
orderByNo
courseIdYes
onlyAnnouncementsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv1.5.4
    • addedInput schema / properties / view
      Added value: +{
      +  "description": "Response shape: \"compact\" (default) drops fields the response already carries elsewhere; \"full\" returns every field this server understands. compact removes the avatar URLs Canvas attaches to user objects (avatar_url, avatar_image_url); \"full\" returns Canvas's payload untouched. Link fields (url, html_url, preview_url) survive both rungs. No field projection: this server passes Canvas's payload through verbatim and has no verified record of which of its fields a caller needs.",
      +  "enum": [
      +    "compact",
      +    "full"
      +  ],
      +  "type": "string"
      +}
  3. Addedv1.2.5

TDQS

C2.7/5.0
Behavior2/5

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

The description says 'read-only', which merely repeats the existing readOnlyHint annotation and adds no new behavioral information. It does not disclose filtering behavior, ordering defaults, pagination, what the response contains, or how onlyAnnouncements affects results. The addition of 'for a course' is minimal and already implied by the required courseId parameter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence and is easy to scan. The parenthetical 'read-only' is slightly redundant with the annotation but does not add meaningful bloat, so the structure earns a solid score.

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

Completeness2/5

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

With four parameters, no output schema, and low schema description coverage, a one-sentence description is insufficient for correct invocation. An agent is left without details on onlyAnnouncements semantics, orderBy behavior, response shape, or how this list relates to the sibling announcements/conversations tools.

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

Parameters2/5

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

With schema description coverage at only 25%, the description needed to compensate by explaining the parameters, but it only references the course scope. The schema itself documents the view parameter well, but orderBy, courseId, and onlyAnnouncements receive no meaningful semantic explanation anywhere.

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), a clear resource (discussion topics), and a scope (for a course), so an agent can tell what operation is being offered. It does not explicitly differentiate from siblings like canvas_list_announcements, though the resource name itself provides most of the distinction.

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

Usage Guidelines2/5

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

There is no guidance about when to use this tool versus alternatives such as canvas_list_announcements, canvas_list_conversations, or canvas_list_assignments. The parenthetical 'read-only' describes safety, not usage context, and no exclusions or alternative-tool routing is provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.