Get Course Roster

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

Annotations already declare readOnlyHint and openWorldHint, but the description adds important behavioral context: by default only instructors and TAs are returned for privacy, and includeStudents expands the result to the full class list. It also previews the returned fields (names, emails, roles).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core action and followed by concise usage, default behavior, and alternative routing. Every sentence earns its place without redundancy.

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

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

With no output schema, the description provides enough return-value context (names, emails, roles), explains the privacy-sensitive default, and clarifies when to use includeStudents versus the sibling email-list tool. No critical calling information is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters are already documented in the input schema. The description reinforces includeStudents and its privacy default, but does not add meaning beyond the schema for limit or searchTerm.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: fetch the roster for a course. It also distinguishes the tool from the sibling get_classlist_emails by explaining that this returns richer user details while get_classlist_emails is for a plain email list.

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

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

Explicitly names user intents that should trigger the tool, such as classmates, instructor contact info, TA emails, and professor names. It also gives the condition for using includeStudents and routes a specific alternative use case to get_classlist_emails.

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