classroom_patch_announcement

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

Annotations only indicate readOnlyHint=false and openWorldHint=true; the description adds little beyond restating that the tool mutates an existing announcement. It does not disclose partial-update semantics, the role of updateMask, or any effects or prerequisites.

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?

A single, front-loaded sentence with no filler or repetition. It communicates the essential purpose economically.

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 six parameters, a required updateMask, and no output schema, the description is not sufficient to guide correct invocation. The agent must discover updateMask semantics and field options from the schema, and there is no guidance on return values or side effects.

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 description provides no parameter-level meaning, and schema description coverage is only 33%, with id, text, state, and courseId lacking descriptions. The updateMask and scheduledTime schema descriptions carry the only semantic load; the description does not compensate.

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 the specific verb 'Edit' and identifies the resource 'an existing announcement,' clearly distinguishing this from sibling tools like classroom_post_announcement (create) and classroom_list_announcements (read).

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 phrase 'Edit an existing announcement' implies usage for modifying an existing resource, but it provides no explicit when-to-use or when-not-to-use guidance and names no alternatives. An agent must infer that creation belongs to classroom_post_announcement.

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