Skip to main content
Glama

Get Quiz Details

get_quiz_details
Read-only

Retrieve a Canvas quiz's settings and your latest attempt details—used, remaining, and kept score—by quiz or assignment ID. Read-only; it does not start attempts or expose questions.

Instructions

Get one quiz's settings and YOUR OWN latest attempt (used, remaining, kept score).

Read-only. It never starts an attempt and never reads questions or answers. Pass exactly one of quiz_id (a Classic quiz, as listed by list_quizzes) or assignment_id (a New Quiz, or the assignment of a graded Classic quiz). For New Quizzes Canvas does not expose settings or attempt history to students, and the result says so. With grading rights in the course, attempts are not requested at all.

Input Schema

NameRequiredDescriptionDefault
quiz_idNoCanvas Classic quiz ID
assignment_idNoCanvas assignment ID (New Quizzes)
course_identifierYesCourse code or Canvas ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.15.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare readOnlyHint, but the description adds substantial behavior: it never starts an attempt, never reads questions or answers, and grading rights change whether attempt data is fetched. It also discloses the degraded result shape for New Quizzes.

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?

Front-loaded with purpose, then safety, then parameter rules, then edge cases. Every sentence carries information; nothing restates the name or title.

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?

No output schema exists, and the description compensates by naming the returned fields and describing what the result says in the unsupported New Quizzes case. An agent has enough to call it correctly and interpret the response.

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%, so the baseline is 3; the description goes further by stating the mutual-exclusivity constraint ('exactly one of') and the identity of each ID type (Classic quiz vs New Quiz/assignment). It doesn't add format details beyond that, so it stops short of a 5.

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 and resource: 'Get one quiz's settings and YOUR OWN latest attempt', and immediately specifies the returned fields (used, remaining, kept score). Clear contrast with the sibling list_quizzes, which is named as the source of quiz_id.

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

Usage Guidelines5/5

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

Explicitly says 'Pass exactly one of quiz_id ... or assignment_id ...', tells the agent where quiz_id comes from (list_quizzes) and what assignment_id covers (New Quiz or graded Classic assignment). It also states the New Quizzes limitation and that with grading rights attempts are not requested, so the agent knows exactly when this tool applies.

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