Sync All Courses

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

Without annotations, the description carries the burden. It discloses the core action (fetch, store, return changes) and a default behavior, but omits side effects like state modification, required permissions, and rate limits. It does not contradict any annotations.

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 efficient sentences. The first front-loads the main function; the second adds a key default. No unnecessary words.

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 tool's complexity (sync with snapshot) and 4 parameters, the description is brief. It covers the core purpose and a default, but does not explain parameters or the snapshot statefulness. Output schema existence partially compensates for return value details.

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 coverage is 0%, yet the description adds no explicit parameter explanations. Only a vague reference to 'assignment detail pages' links to include_assignment_details, but course_limit, include_files, and file_max_depth are unmentioned. The description fails to compensate for the lack of schema descriptions.

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 fetches all visible courses, stores a snapshot, and returns changes, distinguishing it from siblings like get_courses or crawl_course. It also mentions a notable default behavior (skipping assignment details).

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 hints at when to include assignment details for speed, but does not explicitly guide when to use this tool versus alternatives like get_courses or diff_snapshot. No prerequisites or when-not scenarios are mentioned.

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