Skip to main content
Glama

canvas_group

Read-onlyIdempotent

Read one Canvas group's details—name, description, course, and member count—then retrieve its member list with the related members tool.

Instructions

Read one group's details: name, description, course and member count. List its members with canvas_group_members.

Input Schema

NameRequiredDescriptionDefault
rawNotrue: Canvas's unmodified JSON (UTC times, HTML).
pageNoPage to fetch: a number, or the next_page value returned by the previous call.
group_idYesGroup id, from canvas_groups.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered structurally. The description adds value beyond that by disclosing the payload contents (name, description, course, member count) rather than just saying "get group". It does not mention pagination behavior despite the page parameter, which keeps it below a 5.

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 with zero filler: the primary capability and the returned fields come first, and the sibling pointer follows. Nothing is redundant with the name or title.

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 read-only single-resource fetch with a fully documented schema and no output schema, the description gives enough to call it correctly and to know what comes back. The only omission is pagination guidance for the page parameter, a minor gap given the schema documents it.

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 description coverage is 100%, including meanings for group_id, page and raw, so the schema carries the parameter burden. The description adds no format, default, or usage nuance for those parameters beyond what is already documented, which is the baseline case.

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 ("Read one group's details") and enumerates the returned fields (name, description, course, member count). It also distinguishes itself from the sibling canvas_group_members by pointing to it for member listing, so an agent can separate the two without opening schemas.

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?

Explicitly routes the agent to canvas_group_members when member data is wanted, which is the main ambiguity for a group tool. It does not cover when-not-to-use or the relationship to canvas_groups (listing), so the guidance is clear but not exhaustive.

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