qradar_add_offense_note

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

Annotations are absent, so the description carries the full burden. It does state the return value ('JSON string confirming creation of the note'), which adds some transparency. However, it does not disclose potential side effects, required permissions, or whether the operation modifies existing notes, leaving moderate gaps.

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 exceptionally concise: one purpose sentence, a clean Args list, and a returns note. It is front-loaded and every element earns its place.

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?

For a simple two-parameter tool with an output schema, the description provides the essential purpose and return type. It does not dive into edge cases or error conditions, but given the low complexity, it is nearly complete.

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 schema has zero descriptions, but the description's Args section clarifies that offense_id is 'The ID of the offense' and note_text is 'The content of the note.' This adds minimal meaning beyond the parameter names themselves; there is no discussion of formatting, constraints, or behavior specifics.

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 specific action ('Add an analyst note or investigation comments') and the target resource ('an offense'). This distinguishes it from sibling tools like qradar_update_offense or qradar_get_offense without needing to examine their schemas.

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?

No guidance is provided on when to use this tool versus alternatives, or any preconditions such as requiring the offense to exist. The description simply explains what it does; it does not help an agent decide between this and a sibling tool like qradar_update_offense.

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