qradar_add_to_reference_set

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

With no annotations, the description carries the behavioral burden. It adds useful context: the operation mutates a Reference Set, writes an audit trail using the source label, and returns a JSON string confirming the addition. However, it does not disclose duplicate/overwrite behavior, permission requirements, or other side effects for this mutating operation.

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 a compact docstring with a front-loaded purpose sentence followed by an args list and return type. Every part earns its place, with no fluff or repetition.

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?

The description explains what the tool does, all parameters, and the return value, making invocation possible. Still, for a mutating tool with no annotations, it lacks important operational context such as duplicate handling, whether the set must pre-exist, and any required permissions 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?

Schema description coverage is 0%, but the description documents all three parameters: name as the target set, value with the element_type constraint, and source as an audit label with its default. This adds meaning beyond the schema, though concrete value format examples would be stronger.

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 states a specific action—adding an IoC or indicator (IP, domain, hash, URL) into a Reference Set. This clearly distinguishes the tool from siblings like qradar_delete_from_reference_set, qradar_get_reference_set, and qradar_list_reference_sets.

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?

Usage is implied by the action and argument list: use this when adding an indicator to a Reference Set. However, it does not explicitly state when to prefer this over related tools, mention prerequisites like the set needing to exist, or provide exclusions.

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