Skip to main content
Glama

Rate Entry

rate_entry
Destructive

Likes or removes a like on a Canvas discussion entry where ratings are enabled, previewing the change and requiring confirmation before updating the visible like count.

Instructions

Like (rating 1) or remove your like (rating 0) on a discussion entry, where the instructor enabled ratings. Others see the like count. [NEEDS CONFIRMATION: call it once for a preview and a confirm_token, show the preview to the user, and only if they say yes call it again with the same arguments, confirm=true and that confirm_token. Apps that can ask the user directly show a confirmation instead.]

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>",
      "topic_id": "<topic_id>",
      "entry_id": "<entry_id>",
      "rating": "<rating>"
    },
    "name": "rate_entry"
  }
}

Input Schema

NameRequiredDescriptionDefault
ratingYes1 to like, 0 to remove
confirmNoSet to true together with confirm_token to carry out a request you already previewed.
entry_idYesDiscussion entry ID (numeric string). Get it from get_full_topic_view or list_entries.
topic_idYesDiscussion topic ID (numeric string). Get it from list_topics.
course_idYesCanvas course ID, a numeric string such as "12345". Get it from list_courses.
confirm_tokenNoThe one-time token from the preview. Only use it after the user has said yes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / confirm
      Added value: +{
      +  "description": "Set to true together with confirm_token to carry out a request you already previewed.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / confirm_token
      Added value: +{
      +  "description": "The one-time token from the preview. Only use it after the user has said yes.",
      +  "type": "string"
      +}
  2. Changed3 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."
    • changedInput schema / properties / entry_id / description
      Previous value: -"Canvas ID (numeric string)"New value: +"Discussion entry ID (numeric string). Get it from get_full_topic_view or list_entries."
    • changedInput schema / properties / topic_id / description
      Previous value: -"Canvas ID (numeric string)"New value: +"Discussion topic ID (numeric string). Get it from list_topics."
  3. First observedv1.0.1

TDQS

A4.5/5.0
Behavior5/5

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

The description discloses meaningful behavior beyond the annotations: the effect that 'Others see the like count,' the preview-then-confirm flow, the one-time confirm_token, and the need to show the preview to the user before confirming. This is consistent with the mutation-oriented annotations and adds substantial operational context.

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?

The purpose is front-loaded and the confirmation workflow is explained compactly. The bracketed '[NEEDS CONFIRMATION: ...]' marker is slightly awkward and reads like an editorial artifact, but the content is otherwise efficient.

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 mutation tool with no output schema and six parameters, the description covers the essential call flow, side effect, and confirmation requirement. It could mention error behavior when ratings are disabled or permissions are missing, but the critical invocation guidance is present.

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, but the description adds meaning by explaining the 1/0 rating values and the relationship between the preview call, confirm_token, and confirm=true. It does not add further per-parameter constraints beyond that workflow.

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?

The description names a specific action pair, 'Like (rating 1) or remove your like (rating 0),' and the exact resource, a 'discussion entry.' It also distinguishes the operation from sibling discussion tools such as post_entry, reply_to_entry, edit_my_entry, and delete_my_entry.

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?

It gives clear usage context: rating 1 likes, rating 0 removes the like, and the instructor must have enabled ratings. It also explains the confirmation workflow in detail, though it does not explicitly name alternative tools or describe when not to use this one beyond the ratings-enabled condition.

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