Skip to main content
Glama

canvas_get_assignment

Retrieve a Canvas assignment's details and plain-text description by assignment ID, optionally specifying course ID and character limit.

Instructions

Get one assignment, with its description rendered to plain text.

Args: assignment_id: numeric assignment id. 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
assignment_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/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 disclosure burden. It usefully notes the plain-text rendering and the max_chars payload bound, and 'Get' implies a read operation, but it omits auth/permission requirements and error behavior (e.g., missing assignment or unauthorized course).

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-loads the core purpose in the first sentence, then lists parameters compactly in an Args block. No filler; every line supports invocation.

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

Completeness3/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-value detail is not needed, and the max_chars bound is covered. However, for a no-annotation tool the description should also address read-only nature and failure modes, which it does not.

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: it documents all three params, clarifies course_id falls back to CANVAS_DEFAULT_COURSE_ID, and explains max_chars=0 means the server default — semantics not present in the raw schema.

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?

States a specific verb+resource ('Get one assignment') and adds a distinct behavioral note that the description is rendered to plain text. The singular 'one' implicitly differentiates it from canvas_list_assignments, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

Usage is only implied: the required assignment_id signals it is for fetching a single known assignment. There is no explicit when-to-use vs when-not guidance, no mention of alternatives like canvas_list_assignments, and no prerequisites called out.

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