get_grades_report

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

With no annotations, the description carries the burden. It discloses the return format ('JSON with grade items and grades per user') and the optional behavior of user_id (0 or omitted = all users). It does not mention permissions, limitations, or potential errors, but for a read-only 'Get' tool, the information provided is adequate though not comprehensive.

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 concise and well-structured: a one-sentence purpose, an Args list, and a Returns clause. Every sentence provides necessary information without unnecessary detail or repetition.

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?

The description is complete for a simple read-only report tool: it covers purpose, parameters, and return format. It lacks notes on edge cases or authorization, but given the tool's low complexity and presence of an output schema, the description is sufficient for an agent to invoke it correctly.

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?

The schema has no descriptions, so the tool description fully compensates. It clearly explains course_id as 'The Moodle course ID' and user_id as 'Optional user ID to get grades for one student only. 0 or omitted = all enrolled users.' This adds crucial meaning beyond the schema's bare type/default information.

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 tool's function: 'Get grade report for a course (all users or a specific user).' The verb 'Get' and resource 'grade report' are specific. However, it does not explicitly differentiate from the sibling tool get_course_grades, which may have similar functionality, so it falls short of a 5.

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 implies usage by defining the scope (all users or a specific user) and the optional user_id behavior. However, it provides no explicit guidance on when to use this tool versus alternatives like get_course_grades, and it does not mention exclusions or prerequisites.

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