Skip to main content
Glama

canvas_list_notifications

Easily retrieve a user's notifications within the Canvas Learning Management System using this tool to streamline communication and updates.

Instructions

List user's notifications

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.ts:690-697 (registration)
    Tool registration entry in the TOOLS array, defining name, description, and empty input schema
      name: "canvas_list_notifications",
      description: "List user's notifications",
      inputSchema: {
        type: "object",
        properties: {},
        required: []
      }
    },
  • Core handler implementation in CanvasClient that fetches user's notifications via Canvas API /users/self/activity_stream endpoint
    }
    
    // ---------------------
  • Type definition for CanvasNotification, used as return type for the tool's output data structure
    export interface CanvasNotification {
      id: number;
      title: string;
      message: string;
      html_url: string;
      type: string;
      read_state: boolean;
      created_at: string;
      updated_at: string;
      context_type: string;
      context_id: number;
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'List' implies a read-only operation, but it doesn't specify aspects like pagination, sorting, filtering, rate limits, authentication needs, or what constitutes a 'notification' in this context. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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 a single, clear sentence with zero wasted words. It's front-loaded with the core action and resource, making it highly efficient and easy to parse for an AI agent.

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?

Given the tool's low complexity (0 parameters, no output schema) and the description's clarity on purpose, it's minimally adequate. However, the lack of annotations and usage guidelines means the agent might struggle with behavioral nuances like scope or constraints, keeping it from being fully complete.

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?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter details, which is appropriate here. A baseline of 4 is applied since the schema fully handles parameters, and the description doesn't need to compensate.

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?

The description 'List user's notifications' clearly states the verb ('List') and resource ('user's notifications'), making the purpose immediately understandable. However, it doesn't distinguish this from other list tools in the sibling set (e.g., canvas_list_announcements, canvas_list_conversations), which would require more specificity for a perfect score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention context, prerequisites, or differences from other notification-related tools (none are listed in siblings, but this is still a gap). Without any usage cues, the agent must infer based on the name alone.

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

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/DMontgomery40/mcp-canvas-lms'

If you have feedback or need assistance with the MCP directory API, please join our Discord server