moodle_course_sync

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

With no annotations, the description carries the burden of behavioral disclosure. It reveals a key behavior: 'skip unchanged files by size', indicating an incremental sync that avoids redundant work. However, it does not disclose potential side effects (e.g., overwriting local files, requiring network access) or the broader sync behavior beyond skipping unchanged files.

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 only two sentences, front-loaded with the main action and a parenthetical detail, followed by a precise usage recommendation. Every word earns its place with no filler or redundancy.

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?

For a simple sync tool, the description captures the core functionality, the incremental behavior, and a specific use case. An output schema exists, so return values need not be described. It does not mention prerequisites or side effects, but given the tool's apparent simplicity and the presence of an output schema, it is reasonably complete.

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 description coverage is 0%, and the description adds no explicit parameter explanations. It implicitly references 'one course' which aligns with the required course_id, but gives no meaning for the optional parameters 'out' and 'site'. The description does not compensate for the lack of schema info.

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 a specific verb and resource: 'Incremental sync one course' (sync action on a course), and specifies the distinguishing feature 'skip unchanged files by size'. It also gives a use case, 'repair incomplete downloads', which differentiates it from sibling tools like moodle_course_download and moodle_sync_all.

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 clear when-to-use context: 'Use this to repair incomplete downloads'. It does not explicitly mention alternatives or when-not-to-use, but the stated purpose gives meaningful guidance on when this tool is appropriate, setting it apart from generic downloads or full sync.

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