get_ticketsql_grammar

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

The readOnlyHint annotation already establishes that this is a safe read operation. The description adds useful context by identifying the exact version (RT 6.0.3) and framing the tool as a reference, but it does not describe the return format or content structure. With no output schema, a bit more behavioral detail about what the returned reference contains would be helpful.

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?

Two sentences, no filler. The key action is front-loaded, and the second sentence gives concrete guidance about when to consult the reference. Every word 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?

For a zero-parameter, read-only reference tool, the description is fully sufficient. It tells the agent what the tool returns, the version it applies to, and when to consult it. No output schema exists, but the nature of this tool makes the response predictable enough.

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 there is no parameter burden to document. The baseline of 4 applies because no parameter explanation is needed, and the description uses its space for usage guidance instead.

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 ('Returns') and a specific resource ('TicketSQL grammar reference for RT 6.0.3'). It clearly distinguishes itself from sibling ticket-query tools by being the grammar reference rather than a data-fetching tool.

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?

Explicitly tells the agent when to consult it: before writing any TicketSQL query. It calls out the tricky areas where syntax is non-obvious (Status, date/time, custom fields, link fields), which helps the agent decide to use this tool proactively.

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