Encoded query syntax reference

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds that it makes no network call and that malformed queries return empty results rather than errors, providing useful behavioral context beyond the annotations.

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?

Three sentences with zero waste. The first states purpose and key fact (no network call), the second gives explicit usage guidance, and the third explains a critical behavioral quirk. Every sentence earns its place.

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 input schema, no output schema, and no parameters, the description fully explains what the tool does, why it exists, and how to use it effectively. It addresses common misunderstandings, making it complete for a reference tool.

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 tool has zero parameters, so baseline is 4. The description adds significant value by explaining the tool's purpose, usage context, and behavioral nuance, making it excellent for a parameterless reference tool.

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 explicitly states it is 'The full ServiceNow encoded-query operator reference, with worked examples' and notes it 'Makes no network call.' This clearly distinguishes it from sibling tools like servicenow_query_table, which executes queries.

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?

It directly advises 'Read this before guessing at query syntax' and explains pitfalls: encoded queries look like SQL but invite wrong habits, and malformed queries return empty sets instead of errors. This provides explicit when-to-use and when-to-avoid context.

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