preview_course

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

With no annotations and no output schema, the description carries the full burden of behavioral disclosure. It signals an asynchronous generation ('Start a preview generation') but does not explain side effects, job status, required permissions, or how the result is returned.

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 a single front-loaded sentence with no filler. Every word contributes, naming the action, resource, and scope of course types.

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 tool that starts a generation job with three parameters, no annotations, and no output schema, the description omits critical context: how to identify the course, when to provide universitySlug vs organizationSlug, and how to track the resulting job. Sibling tools like get_job_status and wait_for_job exist, but the description does not point to them.

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 description coverage is 0%, so the description must compensate for the three undocumented parameters. It only hints at course types (self-published, organization, university) without mapping them to slug, universitySlug, or organizationSlug, leaving ambiguity about which slug is required for each case.

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 uses a specific verb and resource ('Start a preview generation for a course') and clarifies it covers self-published, organization, or university courses, which distinguishes it from sibling tools like preview_book, preview_subset, and preview_single.

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 this tool is for generating course previews and scopes the course types, but it does not explicitly state when to use this tool versus alternatives, nor does it mention any exclusions or prerequisites.

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