Get Schedule Event Comments

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavioral context beyond that: the exact field set returned and, more importantly, the configuration-dependent failure mode where private-event comments are withheld. It stops short of describing error shape or permission requirements.

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?

Three sentences, each doing work: purpose and payload first, pagination second, failure caveat last. No filler, no repetition of the schema, and the most important information is front-loaded.

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-value documentation is not required, and the description still previews the fields. Combined with the pagination note and the environment-dependent error caveat, an agent has what it needs to call this correctly; only the precise error surface is left unspecified.

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 100%, so limit, offset, and eventId are already fully documented in the schema with ranges and defaults. The description only restates that limit/offset exist 'for pagination' without adding format or interaction detail, so the baseline 3 applies.

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?

States a specific verb and resource ('Get the list of comments on a Garoon schedule event') and enumerates the returned fields (author, creation datetime, body, mentions). It is unambiguously distinct from siblings like garoon-get-schedule-events, which operate on events rather than their comments.

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 clear usage context: pagination via limit/offset, and an explicit condition under which the call fails (GAROON_PUBLIC_ONLY='true' hides private-event comments). It does not name a sibling alternative, but no sibling returns event comments, so there is no real alternative to route against.

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