list_vue_components

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

With no annotations, the description must convey behavior. It only states that it lists .vue files, giving no indication of return format, whether paths are relative or absolute, or whether it scans recursively. It does not mention any side effects or permissions.

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, clear sentence that states the operation and the resource. It is appropriately concise with no redundant words.

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 tool with no output schema, the description only implies the return is a list of .vue files. It doesn't specify nuances like subdirectory traversal or path format, and it doesn't differentiate its use from the related analyze_vue_component 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 only parameter 'name' is described in the schema as 'Name or path of the loaded project.' The description adds no additional meaning to this parameter beyond that.

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 the tool lists .vue files, with a specific verb ('lists') and resource ('.vue files'). It distinguishes from sibling tools like list_files and list_react_components by specifying the Vue file type.

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?

No guidance is given on when to use this tool relative to alternatives like analyze_vue_component or list_files. There is no mention of prerequisites, such as requiring the project to be loaded, aside from what's in the schema.

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