yaaif_api_key_list

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It adds useful behavior: the operation returns "known scopes vocabulary" and clarifies the keys are tenant-scoped ymp- credentials, but it does not explicitly state that this is read-only or describe the response shape/pagination.

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 short sentences carry the resource scope, credential type, destination, and return content with no filler. The core action is front-loaded, and every clause adds meaning.

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 zero-parameter list tool, the description covers what is listed, the nature of the credentials, and the high-level return content. It does not detail the output structure or mention pagination/tenant selection, but complexity is low and no output schema exists to compensate.

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 tool has zero parameters, so the baseline is 4. The description still adds semantic context by explaining what the listed keys are and that scopes vocabulary is part of the returned information, which helps an agent interpret results.

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 a specific verb and resource: "List tenant API keys" and adds clarifying context by calling them "scoped ymp- credentials for MCP/downstream → platform APIs". This clearly separates it from sibling key operations like yaaif_api_key_get, yaaif_api_key_create, and yaaif_api_key_delete.

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 usage is implied: this is the list/enumerate operation for tenant API keys, distinguishable from get/create/update/delete siblings. However, it does not explicitly say when to prefer this tool over yaaif_api_key_get or mention any prerequisites such as needing an active tenant context.

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