set_class_visibility

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

With no annotations provided, the description must carry the burden. It discloses the write prerequisite, the visibility effect, and the date default. It does not discuss edge cases like idempotency, existing posts under a hidden class, or error conditions, but it does state the core behavioral outcome.

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 well-structured: a purpose sentence, a context sentence, and a clear Args list. Every sentence adds value; no fluff. The front-loaded purpose makes it immediately actionable.

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?

An output schema exists, so return values are presumably covered. The description covers all required parameters, the prerequisite, and the effect. It could mention more about side effects, but for a visibility toggle it provides sufficient context for an agent to call it correctly.

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 0%, so the description's Args section is essential. It explains each parameter: school_id as 'School ID', section_ids as 'from list_classes', visible as boolean meaning, and date with format and default. This adds meaning beyond the bare schema and compensates for the lack of schema descriptions.

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 an explicit verb-and-resource pair ('Show or hide classes') and explains the specific audience (staff, parents, students). It also connects to add_class by noting newly created classes start hidden, which distinguishes this tool from other class-related siblings.

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 a clear prerequisite (PS_ENABLE_WRITES) and a concrete scenario: 'a class made with add_class needs this before anyone can see or post to it.' It does not explicitly list alternatives or when not to use it, but the context implies the typical workflow after class creation.

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