splunk_detect_data_quality_issues

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

No annotations are provided, so the description carries the full behavioral burden. It discloses the audit targets (nulls, timestamp skew, format discrepancies), which is useful, but it does not state whether the operation is read-only, what permissions are required, how much data is scanned, or whether there are time-range defaults or limits.

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 short and front-loaded: the audit purpose and checks come first, followed by concise parameter notes. There is little wasted text, though the Args block mostly repeats the schema.

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 values need not be explained. However, for an audit tool with no annotations and zero schema-description coverage, the description is only minimally complete: it lacks when-to-use guidance, read-only behavior, and any default time-range or scan-scope context.

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 does identify the two parameters and marks sourcetype as optional, which is minimally helpful, but the explanations ('Index to audit', 'Optional sourcetype filter') are largely tautological and add little beyond the parameter names.

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 verb (audit) and resource (index/sourcetype), and enumerates the exact checks performed: null values, timestamp skew, and format discrepancies. It is clear what the tool does, though it does not explicitly differentiate itself from nearby data-diagnosis siblings such as splunk_get_parsing_errors or splunk_check_source_coverage.

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 audit framing and optional sourcetype filter, but there is no explicit guidance on when to choose this tool over alternatives like splunk_diagnose_ingestion or splunk_get_field_summary. The agent must infer that this is for data-quality auditing rather than broader ingestion diagnosis.

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