compare_courses

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

The description does not disclose behavioral details like validation of course codes, effects of the semester parameter, or how missing courses are handled. With no annotations, it carries full burden but falls short.

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 two sentences with no redundancy, but omitting the semester parameter reduces efficiency.

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?

Despite having an output schema, the description lacks documentation for the optional semester parameter and potential edge cases, making it incomplete for a 2-parameter tool.

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 description explains the course_codes parameter with an example but ignores the semester parameter entirely. With 0% schema coverage, it should document both 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 tool compares courses on specific attributes (ratings, difficulty, workload, credits, prerequisites) and accepts multiple course codes, distinguishing it from siblings like get_course_details or get_course_ratings.

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 for comparing multiple courses, providing clear context but no explicit exclusions or reference to alternative tools.

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