ncloud_apigw_list_api_keys

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

Annotations already indicate readOnlyHint=true, so the read-only nature is clear. The description adds that it lists 'all' API keys, but does not disclose pagination behavior or potential limits beyond what the schema provides for limit and offset parameters.

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 sentence of 7 words, making it very concise. It front-loads the key action and resource. However, it sacrifices some helpful detail that could be included without significant verbosity.

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 simple listing tool with no required parameters and a read-only annotation, the description is adequate. It covers the core purpose and, combined with the schema, provides a complete picture. The lack of output schema is typical for list tools.

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 description coverage is 100% for both parameters (limit and offset), so the schema already provides necessary parameter meaning. The description adds no additional semantic information beyond the schema.

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 'List all API keys in API Gateway', specifying the verb 'list' and the resource 'API keys in API Gateway'. It distinguishes from sibling tools like ncloud_apigw_list_apis and ncloud_apigw_create_api_key by focusing on keys specifically.

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 provides no guidance on when to use this tool versus alternatives like ncloud_apigw_create_api_key or ncloud_apigw_delete_api_key. It does not mention any prerequisites, filters, or conditions for use.

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