Skip to main content
Glama

List Announcements

list_announcements
Read-onlyIdempotent

Retrieve announcements from selected or all active Canvas courses within a date range, newest first. Filter by unread status to quickly find recent course updates.

Instructions

List announcements from one or more courses in a date range, newest first, with title, author and body. Read-only. Bodies are fenced as untrusted text. Without dates it covers the last 30 days; without course_ids it covers all active courses.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_announcements"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of items to return (one page of results). Smaller is faster.
end_dateNoEnd of the range, as an ISO 8601 date or date-time, e.g. "2026-11-30".
course_idsNoCourse IDs; omit for all active courses
start_dateNoStart of the range, as an ISO 8601 date or date-time, e.g. "2026-11-01".
unread_onlyNoIf true, only announcements you have not read yet.

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 / unread_only
      Added value: +{
      +  "description": "If true, only announcements you have not read yet.",
      +  "type": "boolean"
      +}
  2. Changed3 schema fields changedv1.0.2
    • addedInput schema / properties / end_date / description
      Added value: +"End of the range, as an ISO 8601 date or date-time, e.g. \"2026-11-30\"."
    • 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 / start_date / description
      Added value: +"Start of the range, as an ISO 8601 date or date-time, e.g. \"2026-11-01\"."
  3. First observedv1.0.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive behavior, so the description need not repeat safety basics. It adds useful behavior beyond annotations: announcements are newest-first, bodies are fenced as untrusted text, and omitted filters have defined defaults.

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 compact and front-loaded: purpose and ordering come first, followed by read-only status, security handling, and defaults. Every sentence adds useful information without repetition.

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?

For a read-only list tool with full schema coverage and safety annotations, the definition supplies the operational defaults, ordering, returned fields, and untrusted-content handling an agent needs. No output schema is present, but the prose lists the relevant return fields.

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 100%, so parameters are already well documented. The description still adds meaning by stating the implicit 30-day date default and clarifying course scope, though it does not mention unread_only or limit behavior in prose.

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 ('List announcements'), scopes it to 'one or more courses', specifies ordering ('newest first'), and names the returned fields. The course scope also implicitly distinguishes it from the sibling 'list_global_announcements'.

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 clear default behavior when optional filters are omitted: last 30 days without dates and all active courses without course_ids. It does not explicitly name alternatives such as list_global_announcements, but the course-scoped usage is clear.

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