get_alert_notes

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

With no annotations, the description fully discloses behavior: returns a list of notes with field details, ordering by newest first, empty array if no notes, and raises RuntimeError and ValueError. This exceeds the burden.

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?

Well-structured with sections (Args, Returns, Use Cases, etc.), but slightly verbose for a one-parameter tool. Front-loads main purpose effectively.

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?

Highly complete given low complexity: explains return format, ordering, error handling, and use cases. Output schema exists, so return value details are not required but are provided.

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 description must compensate, but it merely restates 'The unique identifier of the alert' without additional context (e.g., format, length, constraints). Adds minimal value beyond the schema.

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 clearly states the tool retrieves all notes and comments for an alert, using specific verbs like 'Get all notes and comments'. It distinguishes itself from sibling tools like get_alert and get_alert_history.

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?

Provides explicit guidance on when to use (e.g., investigation, collaboration) and suggests checking alert.noteExists to avoid unnecessary calls. Implies when not to use (if no notes exist).

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