query_db

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

With no annotations, the description carries the full burden. It clearly discloses the read-only nature, automatic row limit (1000), and configurable max_rows (up to 10000). It also specifies the database backend (OceanBase Oracle mode). This is sufficient behavioral transparency for a simple read-only query tool.

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?

Description is concise (three sentences), front-loaded with the core purpose, and contains no extraneous information. It could be slightly more structured by separating usage guidelines from behavior, but overall it is efficient.

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 output schema, the description does not explain the return format or error handling. While the tool is straightforward, the lack of output details may leave an AI agent uncertain about the response structure. It is adequate but not fully 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?

Schema coverage is 100%, so baseline is 3. The description adds minimal value beyond schema: it mentions auto-limiting and default max_rows, but these are already implied by the schema descriptions. No further parameter-level details (e.g., format, restrictions) are provided.

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 explicitly states '执行只读 SELECT 查询' (execute read-only SELECT query), clearly defining the tool's purpose as a read-only data query tool. It distinguishes itself from sibling tools (e.g., list_tables, get_table_schema) by focusing on data retrieval via SELECT statements.

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?

Description provides specific usage guidance: use Oracle dialect (NVL, TO_CHAR, etc.) and notes the database is OceanBase Oracle mode. It implicitly advises against using MySQL syntax. However, it does not explicitly state when not to use this tool versus alternatives, such as for DDL or schema exploration.

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