Skip to main content
Glama

Find Recipients

find_recipients
Read-onlyIdempotent

Search by name for people you can message, optionally within one Canvas course. Returns the user IDs needed to send messages or add recipients.

Instructions

Search by name for people you are allowed to message, optionally within one course. Read-only. Returns the user IDs that send_message and add_recipients need.

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": {
      "search": "<search>"
    },
    "name": "find_recipients"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of items to return (one page of results). Smaller is faster.
searchYesName fragment
course_idNoCanvas course ID, a numeric string such as "12345". Get it from list_courses.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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."
  2. Changed2 schema fields changedv1.0.2
    • addedInput schema / properties / course_id / description
      Added 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."
  3. First observedv1.0.1

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the 'Read-only' sentence largely repeats structured data. What does add value is the permission scoping ('people you are allowed to message') and the statement that results are user IDs consumed by other tools. It doesn't mention pagination or result size behavior beyond the schema's limit.

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 that front-load the core action, then scope, then return value. No filler and nothing that could be cut without losing meaning.

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 three-parameter lookup with no output schema, the description covers the key facts an agent needs: permission-limited scope, optional course filter, and the ID-shaped return value feeding other tools. Only paging behavior is unaddressed, and that is documented in the schema.

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%, with search, course_id and limit fully documented in the schema. The description reinforces that search is a name fragment and course_id is an optional single-course filter, which is marginal added meaning over the schema, so the baseline 3 applies.

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 ('Search by name for people you are allowed to message') with an explicit permission scope and optional course constraint. It also names the sibling tools that consume the result (send_message, add_recipients), so an agent can place it precisely in a messaging workflow.

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 makes clear this is the lookup step that feeds send_message and add_recipients, and that the search can be narrowed to one course. It stops short of an explicit when-not or a named alternative, so it's strong context rather than a full routing rule.

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