Get Dashboard Assignments

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

No annotations are provided, so the description carries the transparency burden. It reveals the read-only nature and a performance trade-off, but does not disclose potential issues like rate limits, pagination, or authorization requirements. The output schema exists, so return details are not needed here.

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?

Two sentences with no wasted words. The first sentence immediately states the purpose, and the second provides a key usage tip. Front-loads essential information efficiently.

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?

Given the existence of sibling tools and an output schema, the description is otherwise complete. It covers the core functionality and an optimization flag. Could briefly note that it aggregates across courses, but 'aggregated dashboard page' implies this.

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?

With 0% schema description coverage, the description must compensate. It explains the 'include_details' parameter's effect on performance, adding value beyond the schema's boolean type. However, the 'limit' parameter is not described, leaving a gap. Partial compensation for one of two parameters.

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?

The description clearly states the action ('Return') and specific resource ('assignments listed under the Ninova dashboard's aggregated assignments page'). It distinguishes from sibling tools like 'get_course_assignments' (per-course) and 'get_dashboard_announcements' (different content type).

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?

The description provides a performance optimization tip ('Set include_details=false for a faster list-only read'), but does not explicitly compare this tool to siblings or state when not to use it. The context hints at dashboard vs course-level distinction.

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