query

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

Annotations already declare readOnlyHint=true, and the description adds crucial details: rejection of write statements, limit/offset truncation without SQL modification, and optional transaction handle. No contradictions.

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?

One well-structured sentence that front-loads the core purpose, then lists constraints and options. Every phrase adds value with no redundancy.

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 the output schema exists, the description covers the main aspects: allowed SQL prefixes, write rejection, truncation behavior, and transaction support. It is complete for a general query 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?

Schema covers all parameters at 100%, but description adds semantic context: limit/offset does not modify SQL, tx_handle integrates with transaction_begin, and clarifies the single-statement requirement.

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?

Description clearly states it executes read-only SQL queries on GaussDB, specifies allowed keywords (SELECT/WITH/EXPLAIN/SHOW/VALUES), and returns result rows. It distinguishes from siblings like execute (write operations) and explain_query (specific to EXPLAIN).

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?

Implies usage for read-only queries and bans write statements, but does not explicitly name alternatives like execute for write operations. The single-statement constraint and transaction handle context are clear.

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