Skip to main content
Glama

Get Student Analytics

get_student_analytics
Read-only

Retrieve per-student engagement analytics—page views, participations, and on-time/late/missing assignments—to identify disengaged students in Canvas courses.

Instructions

Get per-student engagement analytics: page views, participations, and on-time/late/missing assignment counts.

Uses Canvas's /analytics/student_summaries endpoint to return a ranked table of every student in the course with an engagement score (0-100) useful for identifying disengaged students in participation/presentation-driven courses.

Input Schema

NameRequiredDescriptionDefault
sort_byNoSort order — "engagement_score" (default, ascending), "page_views", "participations", or "name"engagement_score
course_identifierYesCourse code or Canvas ID
include_access_statsNoInclude page view counts (default: True)
include_participationNoInclude participation counts (default: True)
include_assignment_statsNoInclude on-time/late/missing counts (default: True)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.10.0
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "result": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "result"
      -  ],
      -  "type": "object",
      -  "x-fastmcp-wrap-result": true
      -}New value: +null
  2. Changed15 schema fields changedv1.8.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / course_identifier / description
      Added value: +"Course code or Canvas ID"
    • removedInput schema / properties / course_identifier / title
      Removed value: -"Course Identifier"
    • addedInput schema / properties / include_access_stats / description
      Added value: +"Include page view counts (default: True)"
    • removedInput schema / properties / include_access_stats / title
      Removed value: -"Include Access Stats"
    • addedInput schema / properties / include_assignment_stats / description
      Added value: +"Include on-time/late/missing counts (default: True)"
    • removedInput schema / properties / include_assignment_stats / title
      Removed value: -"Include Assignment Stats"
    • addedInput schema / properties / include_participation / description
      Added value: +"Include participation counts (default: True)"
    • removedInput schema / properties / include_participation / title
      Removed value: -"Include Participation"
    • addedInput schema / properties / sort_by / description
      Added value: +"Sort order — \"engagement_score\" (default, ascending), \"page_views\", \"participations\", or \"name\""
    • removedInput schema / properties / sort_by / title
      Removed value: -"Sort By"
    • removedInput schema / title
      Removed value: -"get_student_analyticsArguments"
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / title
      Removed value: -"get_student_analyticsOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  3. Changed2 schema fields changedv1.3.0
    • removedInput schema / properties / current_only
      Removed value: -{
      -  "default": true,
      -  "title": "Current Only",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / sort_by
      Added value: +{
      +  "default": "engagement_score",
      +  "title": "Sort By",
      +  "type": "string"
      +}
  4. Changed1 schema field changedv1.0.0
    • addedInput schema / title
      Added value: +"get_student_analyticsArguments"
  5. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds useful behavioral facts—the underlying /analytics/student_summaries endpoint, that the result is a ranked table covering every student in the course, and the 0-100 engagement score scale—but says nothing about permissions/teacher-only access, cost of a full-course scan, or pagination.

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?

Two sentences, front-loaded with the payload and followed by the use case; nothing is redundant. The endpoint reference is slightly implementation-detail-heavy but arguably earns its place by signaling the data source.

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?

With no output schema, the description does the necessary work of describing the return value (ranked table of all students with the listed metrics and an engagement score) and its interpretation. What is missing—pagination behavior on large courses and required role/permissions—are modest but real gaps for a course-wide analytics call.

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

Parameters3/5

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

Schema description coverage is 100%, so all five parameters (sort_by, course_identifier, and the three include_* flags) are already documented in the schema. The description adds no additional semantics such as what sort direction means in practice or interaction between the include flags and the engagement score, so baseline 3 applies.

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 and resource ('Get per-student engagement analytics') and enumerates exactly which metrics come back (page views, participations, on-time/late/missing counts) plus the returned shape (ranked table of every student with a 0-100 engagement score). The scope is clearly per-student and course-wide, which implicitly separates it from assignment- or peer-review-level analytics siblings, though none are 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 Guidelines4/5

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

Provides a concrete usage context: 'useful for identifying disengaged students in participation/presentation-driven courses'. That tells the agent when this tool fits, but there are no exclusions or named alternatives (e.g., use get_assignment_analytics for assignment-level breakdowns, get_my_course_grades for grade data).

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