ncloud_list_postgresql_logs

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

Annotations include readOnlyHint=true, and the description's 'List' verb aligns with a read-only operation. The description adds minimal context beyond the annotation, stating the object is 'DB server log files' but does not explain what is returned, any filtering capabilities, or region behavior. No contradiction exists.

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?

The description is a single, concise sentence that is front-loaded with the verb 'List' and clearly states the resource. No extraneous information or 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?

With no output schema, the description doesn't clarify what the returned list of log files looks like (e.g., file names, paths). It adequately conveys the core purpose but leaves expectations about return value structure unstated. Given the tool's simplicity and clear purpose, this is acceptable but not 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?

The input schema fully describes both parameters (regionCode and cloudPostgresqlServerInstanceNo) with 100% coverage. The description itself adds no parameter-level details beyond what the schema already provides, so the baseline of 3 is appropriate.

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 the action (List) and the resource (DB server log files for a Cloud DB for PostgreSQL server instance). This makes the purpose unambiguous, though it does not explicitly differentiate from sibling tools like ncloud_export_postgresql_log or log listing tools for other database types.

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?

No guidance is provided on when to use this tool versus alternatives. It doesn't mention that this tool is specifically for listing PostgreSQL log files, or that ncloud_export_postgresql_log should be used for exporting logs. The user must infer usage from the name.

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