ibmcloud_resource_service_keys

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

With no annotations provided, the description is the sole source of behavioral transparency. The verb 'List' implies a read-only operation, but the description does not disclose pagination, output format, authentication requirements, or how the optional 'instance' parameter affects results. This is minimal disclosure.

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, front-loaded sentence that is easy to parse, but it is somewhat under-specified. It avoids unnecessary verbosity, but it could include a brief note about optional filtering without becoming too long.

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 and no annotations, the description must carry the burden of context. It fails to explain the relationship to service instances, whether listing is global or scoped, or what output the agent can expect. The sibling tools indicate a singular resource getter, but the description does not clarify the distinction.

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 documents the single parameter 'instance' with the description 'Service instance name', so the schema already provides 100% coverage. The tool description adds no additional meaning beyond the schema, such as clarifying that the instance filter is optional or that omitting it lists all keys.

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 uses the specific verb 'List' with a clear resource 'service keys/credentials', which states the core action. However, it does not explicitly distinguish this from the sibling tool 'ibmcloud_resource_service_key' (singular), which likely retrieves a specific key, so the scope (all vs one) is only implied.

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 such as the singular 'ibmcloud_resource_service_key' for retrieving a single key, or the create/delete variants. There is no context about prerequisites or filtering by instance.

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