qql_help

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds the behavioral detail that only one section is returned per call and that the agent should request a specific topic, which is useful beyond the annotations. No contradiction exists.

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 three sentences, with the main purpose front-loaded, followed by concise usage guidance. Every sentence adds value, and there is no redundant or vague text.

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 one-parameter tool with a rich enum schema and helpful annotations, the description fully covers what the tool does, how to use it, and which topic to choose. No output schema is needed for a reference section, and the description is sufficiently complete.

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 has 100% coverage with a detailed enum description for the topic parameter. The description adds use-case mappings for certain topics (entities, aggregation, enumValues), which goes beyond the schema's per-option descriptions and helps the agent decide which parameter value to use.

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 the tool's function: 'Get one section of the Qase Query Language (QQL) reference.' It uses a specific verb ('Get') and resource ('QQL reference'), and distinguishes itself from the sibling qql_search tool, which is for executing queries, by focusing on retrieving documentation.

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 provides explicit guidance on which topic to use in different scenarios ('Start with "entities" when you are unsure which fields an entity has... "aggregation" to count or summarise without paging, and "enumValues" for valid field values') and warns against requesting the whole reference ('ask for the section you need rather than the whole reference'). This helps the agent choose correctly.

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