sync_course_files

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

No annotations provided, so description carries full burden. Discloses incremental behavior, skip unchanged files, force re-download, and content sources. But missing details on directory creation, error handling, or concurrency. Adequate but not exhaustive.

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?

Highly concise: one sentence for purpose, one analogy, one note on force, then bullet list of args. No fluff. Front-loaded with main action. Every sentence is informative.

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 4 parameters, sibling tools, and existence of output schema, description covers core behavior, parameter semantics, and use case. Lacks guidance on invalid course ID handling, sync stop, or network dependency. Still reasonably complete for a file sync 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?

Schema has 0% description coverage, but description explains each parameter: course_id, force (re-download), sources (defaults to all types), destination (overrides configured path). Provides default values and behavior. However, does not specify allowed values for sources (e.g., exact strings like 'files', 'assignments'). Adds significant value beyond schema.

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?

Clearly states 'Sync (download) all files for a Canvas course to the local filesystem.' Uses verb 'sync/download' and resource 'files for a course'. 'Behaves like "git pull"' analogy strongly distinguishes from sibling tools like download_file (single file) or download_selected_files (specific files).

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?

Provides clear context: incremental sync vs. force re-download. Implicitly suggests use for updating local copies. However, lacks explicit when-not-to-use or comparison with alternatives like download_file or get_syllabus. Does not mention prerequisites like network connectivity.

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