Skip to main content
Glama

search_users

Read-only

Find users in a Canvas account by name, login, or email. Optionally include extra fields like email, last login, avatar, time zone, or UUID.

Instructions

Search for users in a Canvas account by name, login, or email. Use include to request email, last_login, avatar_url, time_zone, or uuid in the response.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
account_idYesThe Canvas account ID
search_termYesThe search term (name, login, or email)
sortNoSort field
orderNoSort order
includeNoExtra fields to include on each user (Canvas include[] param)
Behavior3/5

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

Annotations already provide readOnlyHint and openWorldHint. The description adds value by explaining the 'include' parameter for extra fields, but does not disclose pagination, result limits, or other behavioral traits.

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 sentences that are front-loaded: first states the core purpose, second adds key usage detail on 'include'. No redundant information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description does not mention return format (e.g., array of user objects) or pagination. For a search tool, this missing context reduces completeness, though basic functionality is clear.

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%, so baseline is 3. The description adds minimal extra meaning beyond the schema, only noting that 'include' can request specific fields. No additional context for other parameters like sort and order.

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 specifies the verb 'Search', the resource 'users in a Canvas account', and the search criteria (name, login, email). It clearly distinguishes from sibling tools like list_course_users and get_user by focusing on search with multiple criteria.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives such as list_course_users or get_user. Lacks explicit when-to-use, prerequisites, or exclusion criteria.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bruchris/canvas-lms-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server