Skip to main content
Glama

List Entries

list_entries
Read-onlyIdempotent

Lists top-level discussion entries for a Canvas course topic page by page, enabling read-only browsing of replies without loading the entire thread.

Instructions

List top-level entries in a discussion topic, page by page. Read-only. Entry text is fenced as untrusted. Prefer get_full_topic_view to read a whole thread at once.

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>"
    },
    "name": "list_entries"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoWhich page of results to show, starting at 1. Use it when a result says there are more.
limitNoMaximum number of items to return (one page of results). Smaller is faster.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.0
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of items to return. Smaller is faster."New value: +"Maximum number of items to return (one page of results). Smaller is faster."
    • addedInput schema / properties / page
      Added value: +{
      +  "description": "Which page of results to show, starting at 1. Use it when a result says there are more.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
  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 / limit / description
      Previous value: -"Max items to return"New value: +"Maximum number of items to return. Smaller is faster."
    • 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.4/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior, so the description does not need to repeat safety hints. It adds two useful behavioral details: results are paginated ('page by page') and entry text is fenced as untrusted. It does not cover return shape or rate limits, so it is strong but not exhaustive beyond annotations.

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, with purpose first and the routing alternative last. Every clause carries information: scope, safety, and pagination/security context. No filler.

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?

The definition covers purpose, pagination, read-only safety, and an alternative, while annotations and full schema handle safety and parameters. For a moderately simple list tool without an output schema, the lack of return-field detail is a minor gap. It is complete enough to invoke correctly.

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 the schema already explains course_id, topic_id, page, and limit with sourcing guidance. The description's 'top-level' clarifies which entries are listed and 'page by page' reinforces pagination, but adds no parameter syntax or constraints beyond the schema. Baseline 3 is appropriate.

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 gives a specific verb and scoped resource: listing top-level entries in a discussion topic, page by page. The 'top-level' qualifier separates it from reply-listing siblings, and naming get_full_topic_view distinguishes the whole-thread alternative. An agent can identify what it returns without opening the schema.

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

Usage Guidelines5/5

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

It explicitly routes whole-thread reading to get_full_topic_view, giving a clear when-not condition. It implies this tool is for paginated top-level entry listing rather than replies, and the named alternative makes selection clear.

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