list_metric_analyses

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

No annotations are provided, so the description must fully disclose behavioral traits. It only states that the tool retrieves a list, with no mention of filtering behavior, return format, whether it is read-only, or any limitations. This is a minimal disclosure that leaves the agent without expectations for the operation's behavior.

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, concise sentence that states the resource and action without unnecessary detail. It is front-loaded and easy to parse.

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?

The tool has no output schema and no annotations, so the description should explain what the response contains or how to use the filters. It only provides the basic purpose, omitting information about return structure, pagination, or how optional parameters affect results. This is incomplete for an agent to use effectively.

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 description makes no mention of the parameters, but the input schema covers two of three parameters with descriptions and the status parameter has a self-explanatory enum. Schema description coverage is moderate (67%), so the description adds no extra meaning, but the schema provides adequate context for parameter usage.

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 a specific action ('retrieves the list') and a clear resource ('metric analysis history stored in CodeVi backend'). This clearly distinguishes it from sibling tools like get_metric_analysis (singular) and list_smell_analyses (different analysis 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?

The description implies usage as a list operation but does not explicitly state when to use this tool versus alternatives such as get_metric_analysis or run_metric_analysis. No exclusions or conditional guidance are provided, leaving the agent to infer from the tool name and context.

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