add_alert_notes

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

With no annotations, the description must cover behavioral traits. It discloses that notes are overwritten and that an empty string clears them, and mentions server targeting. However, it does not state idempotency, error behavior, 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?

The description is two sentences plus one line for server, no wasted words. It front-loads the main action. The server explanation could be integrated more smoothly, but overall it is efficient.

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 the presence of an output schema (not shown), return values need not be explained. The description covers the core action and the key parameter (notes clearing). For a simple tool with three parameters, it is reasonably complete, though side effects like overwriting existing notes are not explicitly stated.

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%, so the description must compensate. It explains the 'server' parameter and the clearing behavior of 'notes', but 'alert_id' is not elaborated. It adds some meaning beyond the schema (e.g., empty string clears notes) but not full coverage.

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 action ('Add (overwrite)') and the resource ('analyst notes on an alert'). It distinguishes from sibling tools like 'add_alert_tags' by specifying notes rather than tags. The clarification about clearing notes via empty string adds precision.

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 usage for setting or clearing notes but does not explicitly state when to use this tool versus alternatives like 'get_alert' (which retrieves notes). No guidance on exclusions or context is provided.

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