list_apps

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

No annotations are provided, so the description carries the full burden. The verb 'List' implies a read-only operation, and the description specifies the output format 'webApps/<name>', but it does not explicitly state that it does not modify anything or surface potential side effects. This is adequate but minimal.

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, focused sentence that front-loads the action and resource. It contains no filler, repetition, or unnecessary details, making it highly efficient.

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 list tool with one optional parameter, and the description covers the core purpose and the output format 'webApps/<name>'. The schema handles parameter details, and no output schema exists, so the description adequately explains what to expect. It lacks mention of error cases or empty results, but that is not critical for this tool.

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 single parameter 'repo' is fully described in the input schema (100% coverage), so the description adds no additional parameter meaning. The schema already explains path resolution, defaults, and how to list available repos, so the description's omission of parameter details is acceptable.

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 states 'List VBCS web app names (webApps/<name>) present in a repo checkout', giving a specific verb (List), resource (VBCS web app names), and scope (repo checkout). The format 'webApps/<name>' distinguishes it from siblings like list_repos and list_artifacts.

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 implies the tool is for enumerating app names in a repo checkout, but it doesn't explicitly mention when to use this over alternatives like vbcs_list_applications. However, the context of 'repo checkout' provides clear situational guidance for when this tool applies.

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