fluig_rm_db_query

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

With no annotations, the description carries the full burden. It correctly declares read-only behavior ('Read-only (SELECT/WITH only)'), which is critical. However, it fails to disclose potential behaviors such as error handling, connection requirements, or what happens with invalid SQL, which would be beneficial for an AI agent.

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 with no filler. The description is front-loaded with the core function and constraints. Every word serves a purpose.

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?

The description covers the key aspects (what, where, read-only) but lacks information about return format or output behavior. Given there is no output schema, the description should at least indicate what the tool returns (e.g., rows, error messages) to be 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% with one parameter (sql). The description echoes the schema's description ('SELECT ... (SELECT/WITH only)'), adding no new semantic details beyond confirming allowed SQL types. The baseline of 3 is appropriate as schema already documents the parameter adequately.

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 it runs SELECT queries against the TOTVS RM database, distinguishing it from write tools like fluig_rm_db_exec and generic queries like fluig_db_query. The verb 'Run a SELECT directly' and specification 'Read-only (SELECT/WITH only)' provide precise purpose.

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 mentions a prerequisite ('when Fluig has a datasource for it') but does not provide explicit guidance on when to use this tool versus alternatives like fluig_db_query or when not to use it. The read-only constraint is clear, but no exclusions or alternatives are named.

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