splunk_search_stream

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

No annotations are provided, so the description must carry the behavioral burden. It discloses progressive streaming through the export endpoint and that count caps the number of events, but does not state read-only/non-destructive behavior, permissions/auth requirements, or cancellation semantics.

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 front-loaded and free of wasted prose, with the core behavior in the first sentence and parameters listed compactly. It is appropriately concise, though the terse Args block leaves little room for necessary clarification.

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 no annotations, 0% schema description coverage, four parameters, and many similar search siblings, the description is not complete enough. The output schema covers return values, but time formats, count default behavior, streaming details, and safety context are missing.

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 names all four parameters with minimal meanings, but omits critical details such as Splunk time format syntax for earliest_time/latest_time and whether null has special behavior; this is insufficient for reliable invocation.

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?

States a specific verb, resource, and method: stream search results progressively via the Splunk export endpoint. Clear enough to identify the tool, but among many search siblings (splunk_search, splunk_search_async, splunk_export_search_results) it does not explicitly differentiate when this variant should be chosen.

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 phrase 'stream search results progressively' implies the streaming use case, but there is no explicit guidance on when to use this tool instead of sibling search tools, nor any exclusions or prerequisites. Usage is only inferred from the purpose statement.

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