Skip to main content
Glama

List My Planner Items

list_my_planner_items
Read-only

The authenticated student's planner: assignments, ungraded quizzes, planner notes, wiki pages, ungraded discussions, calendar events, peer reviews, sub-assignments and peer-review sub-assignments — everything with a due or to-do date…

Instructions

The authenticated student's planner: assignments, ungraded quizzes, planner notes, wiki pages, ungraded discussions, calendar events, peer reviews, sub-assignments and peer-review sub-assignments — everything with a due or to-do date, across every course and group at once. Strictly richer than get_todo_items, which covers only assignments needing submitting or grading. Four caveats: (1) start_date and end_date must be given TOGETHER or OMITTED TOGETHER — supplying only one makes Canvas silently default the other side to a ten-year window, so a half-specified range is rejected outright; omitting both resolves to Canvas's own ~2-week default, echoed back as the response's start_date/end_date. (2) context_codes (e.g. "course_123", "group_7") restricts to those contexts; omit it for every context the student belongs to — an empty array is rejected rather than silently meaning "all". (3) submissions is false when the item has no gradable submission, or an object when it does — never null. (4) a planner note has no html_url (Canvas exposes none for individual planner notes).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filterNonew_activity = unread/new only; incomplete_items / complete_items filter on planner-override completion and submission state.
end_dateNoInclusive end, YYYY-MM-DD or ISO 8601. Must be given together with start_date.
max_itemsNoMaximum items to return (default 100). When the limit is reached, `truncated` is true and `truncation_note` explains how to narrow the query.
start_dateNoInclusive start, YYYY-MM-DD or ISO 8601. Must be given together with end_date.
context_codesNoRestrict to these contexts, e.g. ["course_123","group_7"]. Defaults to every context the student belongs to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.18.15

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only declare readOnly/openWorld, but the description adds rich behavioral context: the start_date/end_date must-be-paired rule and Canvas's silent ten-year default window, the ~2-week default echoed back in the response, rejection of an empty context_codes array, the never-null submissions field, and the absent html_url on planner notes. These are real pitfalls an agent could not infer from annotations.

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?

Front-loaded with the tool's scope before the enumerated caveats, and every caveat carries actionable content. It is longer than typical, but little is wasted; the numbered structure aids scanning. Slight verbosity in the item enumeration keeps it from a 5.

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?

With no output schema, the description compensates by explaining return-field behavior (submissions shape, missing html_url, echoed start_date/end_date) and truncation is covered in the schema. For a 5-param, zero-required tool, an agent has everything needed to call it correctly.

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 coverage is 100% (baseline 3), but the description adds genuine semantics beyond the schema: the pairing constraint on start_date/end_date, the silent default-window failure mode, and the empty-array rejection for context_codes. These inform how to construct values, not just what they mean.

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+resource ('The authenticated student's planner') and enumerates exactly what it returns (assignments, ungraded quizzes, planner notes, wiki pages, calendar events, peer reviews, etc.). It also explicitly distinguishes itself from get_todo_items. An agent can tell this apart from siblings like list_calendar_events or get_upcoming_events without opening a schema.

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?

Explicitly names the closest alternative and the selection rule: 'Strictly richer than get_todo_items, which covers only assignments needing submitting or grading.' This gives clear when-to-use guidance. It does not address other potentially overlapping siblings (list_calendar_events, get_upcoming_events, get_missing_submissions), so it stops short of full exclusion guidance.

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