xql_get_quota

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

No annotations are provided, so the description carries the burden. It discloses behavior by noting the dependency on a specific query initiation endpoint, the parallel query limit, and required licenses. It does not detail the response format, but the purpose is a simple quota check and the description provides adequate context.

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 a clear title, definition, notes, and an example. It is slightly longer than the minimum but every section contributes meaningful information, and the formatting enhances readability.

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 no-parameter, no-output-schema tool, the description is complete. It explains what the tool does, the specific condition for usage, a relevant quota limit, required licenses, and provides an example request. No critical information seems 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?

The schema defines zero parameters, and the baseline is 4. The description adds value by showing an example request body with 'request_data': {}, clarifying the expected input shape despite the schema being empty. This is helpful for 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?

The description clearly states 'Get XQL query Quota' and 'Retrieve the amount of query quota available and used,' providing a specific verb and resource. It is easily distinguished from sibling tools like xql_start_xql_query or xql_get_query_results, which focus on running or fetching query results.

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 gives explicit usage context, including the note that the endpoint only works on queries initiated by /public_api/v1/xql/start_xql_query/ and mentions the parallel query limit. It does not explicitly name alternative tools for different scenarios, but the context is clear enough for correct selection.

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