Skip to main content
Glama

Set Course Nickname

set_course_nickname
Idempotent

Assign a private nickname to a Canvas course so it appears under that name only in your own view; other users see the original course name.

Instructions

Give a course a personal nickname that replaces its name in your own Canvas view. Only you see it; the course is unchanged for everyone else. Undo with remove_course_nickname.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>",
      "nickname": "<nickname>"
    },
    "name": "set_course_nickname"
  }
}

Input Schema

NameRequiredDescriptionDefault
nicknameYesThe nickname to show for this course. Only you see it.
course_idYesCanvas course ID, a numeric string such as "12345". Get it from list_courses.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.2
    • changedInput schema / properties / course_id / description
      Previous value: -"Canvas course ID"New value: +"Canvas course ID, a numeric string such as \"12345\". Get it from list_courses."
    • addedInput schema / properties / nickname / description
      Added value: +"The nickname to show for this course. Only you see it."
  2. First observedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint=false, destructiveHint=false, idempotentHint=true), so the description's added value is the blast-radius statement: "Only you see it; the course is unchanged for everyone else." That is exactly the context an agent needs before writing, though nothing is said about error behavior for invalid course IDs.

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?

Three short sentences, front-loaded with the action and effect, then the isolation guarantee, then the escape hatch. No filler and the ordering matches how an agent would reason about the call.

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?

A two-required-parameter preference write with full schema coverage and a complete annotation set; the description supplies the one thing annotations cannot, namely visibility scope, plus the undo sibling. Minor gap: no mention of what the call returns or whether re-setting overwrites the prior nickname.

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 coverage is 100% and both fields are documented in-schema, including the hint to obtain course_id from list_courses. The description adds no format, length, or clearing semantics for nickname (e.g. whether an empty string removes it), so the baseline 3 applies.

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 ("Give a course a personal nickname") and immediately fixes the effect: it replaces the name in the caller's own view. That scoping detail lets an agent distinguish it from generic course-mutation tools without inspecting any 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?

Names the direct reversal path explicitly ("Undo with remove_course_nickname") and implicitly frames this as a personal-preference write rather than a course edit. It stops short of stating prerequisites, e.g. that the course must be one the user is enrolled in or previously favorited.

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