Skip to main content
Glama

search_users

Read-only

Search for Canvas users by name, login, or email within an account, with options to 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 indicate readOnlyHint=true and openWorldHint=true, which the description does not contradict. The description adds no extra behavior details beyond the schema, such as pagination or result limits. Given annotations cover safety, a score of 3 is appropriate.

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: the first states the purpose clearly, the second adds a concrete usage tip. No redundancy or fluff.

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 description covers the core purpose and includes a helpful tip. However, given no output schema, additional context on return format or pagination would be beneficial. Sibling tools and annotations partially compensate.

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 the description's addition of a usage tip for the `include` parameter provides marginal value beyond the schema. Baseline 3 is warranted.

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 clearly states the tool searches for users by name, login, or email in a Canvas account. It distinguishes from siblings like list_account_users (which lists all users without search) and get_user (specific user).

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?

The description advises using the `include` parameter to request additional fields, providing context for that parameter. However, it does not explicitly guide when to use this tool vs siblings like list_account_users for listing all users.

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