publish_preview

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

With no annotations, the description carries the burden. It discloses the hidden preview state, that students will not see anything until confirm_preview, and the return shape (same as publish_class_lesson plus preview_url). This provides meaningful behavioral context, though it omits details like permission requirements or whether the preview is overwritable.

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 sentences, front-loaded with the core purpose. The second sentence adds essential behavior (hidden from students) and return shape. No wasted 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?

For a simple two-parameter tool, the description covers the key context: the preview workflow and what to expect in the response. It references publish_class_lesson for extended return details, which helps completeness, but lacks any error/side-effect information.

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%, and the description does not explain what lesson_path or course_id represent or how they are used. The parameter names are somewhat self-explanatory, but the description adds no additional semantic value.

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 states a specific action: 'Publish a LessonPlan in hidden preview mode.' It clearly identifies the resource (LessonPlan) and the mode (hidden preview), and differentiates from siblings by referencing publish_class_lesson and confirm_preview.

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 the intended workflow: use this to create a preview, then call confirm_preview to make it visible. It references publish_class_lesson for shape comparison, but doesn't explicitly state when to prefer this over other publishing tools.

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