xql_get_query_results_stream

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

With no annotations, the description carries the transparency burden and discloses several behavioral traits: chunked transfer encoding, optional gzip via Accept-Encoding header, the four-parallel-query quota, and required license tiers. It stops short of explaining error behavior or stream consumption details, so it is not fully transparent.

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 well-structured with sections for the overview, notes, license, endpoint, and example, with the key purpose front-loaded. It is somewhat long but most content is relevant; the slight redundancy between the gzip header instruction and the example's is_gzip_compressed field is minor.

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 covers the endpoint path, example request, license, prerequisite, quota, and response encoding, providing solid invocation context. It lacks an output schema and does not describe the exact response body structure beyond chunked/gzip, so the stream format remains only partially specified.

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 example JSON body shows the nested request_data with stream_id and is_gzip_compressed, which helps structure. However, the meaning of is_gzip_compressed remains ambiguous because the description instructs using the Accept-Encoding header for gzip but does not clarify the field's role. The schema only says 'A boolean flag,' so neither source fully explains it.

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 this tool retrieves XQL query results as a stream for result sets larger than 1000 results. It also notes the endpoint only works with queries initiated by start_xql_query, which distinguishes it from xql_get_query_results and xql_query in the sibling list.

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 explicitly mentions the >1000-result use case and the prerequisite that the query must originate from start_xql_query, and provides quota guidance. It does not explicitly name the alternative for <=1000 results, but the threshold strongly implies when to use this stream endpoint.

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