list_labs

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

No annotations are provided, so the description must disclose behavior. It states the default filtered view and the permission requirement for show_all, which is critical. It does not explicitly say it is read-only, but 'List' implies no mutation, and the output schema likely covers return shape.

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 concise sentences convey the action, default scope, parameter option, and permission requirement with zero filler. The most important information is front-loaded.

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?

This is a simple one-parameter list operation with an output schema. The description covers the key context (default scope, admin permission for show_all) and is sufficient for an agent to select and invoke the tool correctly. No significant gaps remain.

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 0%, so the description must explain the parameter. It does: show_all is described as returning every lab on the controller and needing admin rights, while the default false is explained by 'By default only labs owned by the authenticated user.' This adds complete meaning beyond the bare boolean type.

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 ('List') and resource ('CML labs') and clearly distinguishes the default scope (user-owned) from the admin-only show_all scope. This differentiates it from sibling tools like create_lab, delete_lab, and list_example_topologies.

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?

It provides clear usage context: by default it lists only the authenticated user's labs, and show_all=True for all labs requires admin rights. It does not explicitly mention alternatives, but no other sibling tool is a direct substitute for listing labs.

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