Skip to main content
Glama

Remove Course Nickname

remove_course_nickname

Remove a personal course nickname to restore the official Canvas course name in your own view.

Instructions

Remove your personal nickname for a course so Canvas shows its official name again. Only affects your own view.

Input Schema

NameRequiredDescriptionDefault
course_idYesCanvas course ID, a numeric string such as "12345". Get it from list_courses.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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."
  2. First observedv1.0.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations only declare write/safety hints; the description adds the meaningful behavioral fact that the change is scoped to the caller's own view and does not alter the course for anyone else. It does not say whether removing a nonexistent nickname errors or is a no-op, which matters given idempotentHint=false.

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?

Two short sentences, effect first and scope second, with no filler. Every clause carries information an agent would otherwise have to guess.

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?

For a one-parameter, non-destructive mutation this covers what the agent needs: what is removed and whose view it affects. A brief note on behavior when no nickname exists and an explicit pointer to set_course_nickname would close the remaining gap.

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?

The single course_id parameter is fully documented in the schema, including format and where to obtain it, so the baseline of 3 applies. The description adds nothing about the parameter itself.

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 (remove) and resource (personal course nickname) plus the observable outcome — Canvas reverting to the official name. It does not explicitly name the sibling set_course_nickname/list_course_nicknames, so differentiation is implied by the verb rather than spelled out.

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?

"so Canvas shows its official name again" implies the situation in which to use it, but there is no explicit when-not, no prerequisite (e.g. a nickname must exist), and no named alternative such as set_course_nickname for renaming instead of removing.

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