Skip to main content
Glama

canvas_list_announcements

Lists a Canvas course's announcements, most recent first, with their text so instructors can check updates or gather content.

Instructions

List a course's announcements, most recent first, with their text.

Args: course_id: numeric course id; defaults to CANVAS_DEFAULT_COURSE_ID. max_chars: bound on the returned payload (0 = the server default).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idNo
max_charsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, but it does disclose two useful traits: results are ordered most-recent-first and max_chars bounds the returned payload. It says nothing about pagination, permissions/authentication, or scope beyond the course, so coverage is partial.

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 purpose sentence is front-loaded and tight, and the Args block documents each parameter compactly. No filler sentences.

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?

An output schema exists, so return structure need not be re-explained, and both parameters plus their defaults are covered. For a simple two-parameter listing tool this is nearly sufficient, lacking only failure/auth context.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate and largely does: course_id is described as numeric and defaulting to CANVAS_DEFAULT_COURSE_ID, and max_chars as a payload bound where 0 means the server default. Only the exact units/behavior of max_chars truncation remain unspecified.

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 gives a specific verb and resource ('List a course's announcements'), plus ordering ('most recent first') and payload contents ('with their text'). It is clearly distinguishable from the write-side sibling canvas_post_announcement, though it does not call that sibling out by name.

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 explicit when-to-use or when-not-to-use guidance, and no alternative tool is named. Usage is only implied by the verb 'List' versus the create/post siblings in the toolset.

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