ntulearn_sync_materials

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

Annotations cover the safety profile (idempotent, non-destructive, open-world), but the description adds real mechanism: manifest + checksum-based incremental logic, preservation of local edits, and the guarantee that files are never deleted. It still omits auth requirements, rate limits, and how the openWorld remote fetch behaves on failure.

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?

Four tight sentences, front-loaded with the action and mode, then defaults, then mechanism, then the validation caveat. No filler and every sentence carries information.

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?

No output schema exists, but the description compensates by naming the errors and truncated result fields an agent must check. Combined with the annotations, an agent has enough to invoke correctly, though the under-documented non-required parameters leave a small gap.

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 only 17%, so the description must carry the load. It clarifies dry_run's default and hints at truncation (max_items) and the folder layout that informs semester/destination_dir, but course_ids and max_items semantics are never explained and semester/destination_dir formats remain unstated.

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 (sync) and resource (course files) with an explicit destination scope (semester/course/original folders), plus the two modes (preview vs incremental sync). This clearly separates it from every read-only sibling like ntulearn_download_file or ntulearn_get_course_contents.

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?

Gives clear operating context: default dry_run=true, use it to preview, and inspect errors/truncated before declaring success. It does not name alternatives or exclusions (e.g., when to prefer ntulearn_download_file), so it stops short of a full when/when-not statement.

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